How do I retrieve a list of Encoders from the Server?

This simple code snippet shows you how to get access to the Encoders that the logged-in user has access to on your Server.

The list returned will also indicate which of those Encoders are currently connected to the Server and available for viewing.

Prerequisite: This example requires a Server object that is already connected.

The general steps required are:

• Call QueryEncoders() on your Server object. If successful you will given an Encoders object which is a collection of Encoder objects.
• You can either enumerate over the collection, or call GetEncoder() to retrieve the Encoder required.

For complete examples refer to the sample applications that come with the DecoderSDK.

Example

• C++
• C#
• Android

// Retrieve the list of all encoders available to this user
// This list will be cached in the SDK
EncodersList encoders;
result = server->QueryEncoders(encoders);
if (result != OR_Success)
{
  wcout << L"Failed to retrieve encoder list" << endl;
  return;
}

// Find a particular encoder in the cached list of encoders.
// The QueryEncoder method results in a message to the server instead.
Encoder enc = server->GetEncoder(L"MyEncoder");

if (!enc.IsValid())
{
  wcout << L"Failed to find the requested encoder - do you have permission to access it?" << endl;
  return;
}

// register to receive IEncoderListener callbacks
enc.RegisterListener(this);

//Retrieve information on the Encoder
std::wstring name = encoder.Name();
std::wstring uuid = encoder.UniqueID();
boolean isConnected = encoder.IsConnectedToServer();

// Retrieve the list of all encoders available to this user
// This list will be cached in the SDK
EncoderList encoders = new EncoderList();
result = _server.QueryEncoders(encoders);
if (result != OpResult.OR_Success)
{
    Console.WriteLine("Failed to retrieve the encoder list");
    return;
}

// Find a particular encoder in the cached list of encoders.
// The QueryEncoder method results in a message to the server instead.
_encoder = _server.GetEncoder(ENCODER);

if (!_encoder.IsValid())
{
    Console.WriteLine("Failed to find the requested encoder - do you have permission to access it?");
    return;
}

// Register to receive IEncoderListener callbacks
EncoderListener _encoderListener = new EncoderListener();
_encoder.RegisterListener(_encoderListener);

// Display some information from the encoder, including UUID
PrintEncoderInfo(_encoder);

// Retrieve the list of all encoders available to this user
// This list will be cached in the SDK
final EncoderList encoders = new EncoderList();
OpResult opResult = server.QueryEncoders(encoders);
if(opResult == null || !opResult.toString().equals(OpResult.OR_Success.toString())){
  Log.w(TAG, "Failed to retrieve encoder list");
  return;
}

// Find a particular encoder in the cached list of encoders.
// The QueryEncoder method results in a message to the server instead.
encoder = server.GetEncoder(ENCODER);
if(encoder == null || !encoder.IsValid()){
  Log.w(TAG, "Failed to find the requested encoder - do you have permission to access it?");
  return;
}

// Register to receive IEncoderListener callbacks
encoderListener = new SDKEncoderListener();
encoder.RegisterListener(encoderListener);

// Display some information from the encoder, including UUID
printEncoderInfo(encoder);