An encoder can send events and alarms that can be triggered on the encoder.

See the system documetation for the type of events that can be triggered.

Prerequisite: This example requires a Server and Encoder object

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

Example

Register for the encoder listener

// Register to receive IEncoderListener callbacks

encoder.RegisterListener(this);

Process the encoder event call backs

void GeneralSample::DoProcessStatusEvent(EncoderStatusInfo statusInfo, Encoder encoder)
{
  if (statusInfo.IsValid() && encoder.IsValid())
  {
    // the EncoderStatusInfo class provides a DisplayString as a convenience for 
    // describing the contents of the event
    std::wstring displayString = statusInfo.DisplayString();
    wcout << L"Status event received for " << encoder.Name() << L":" << endl;
    wcout << L"  " << displayString << endl;
    // to obtain the raw parameter contents associated with the event use the Params() method.
    std::map< std::wstring, std::wstring > eventParams = statusInfo.Params();
    // the timestamp of the event can be retrieved as follows:
    long long timestamp = statusInfo.TimeStamp();
  }
}

Register for the encoder listener

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

Process the encoder call backs

public class EncoderListener : IEncoderListener
{
    public override void SettingsUpdated(EncoderSettingsChangeInfo eventInfo, EdgeVisDecoderSDK.Encoder encoder)
    {
        // This method is called when the encoder has had its settings modified by another client.
        // The changes to the encoder's configuration are applid to the SDK internally.  The client 
        // application should obtain these from the SDK again to update any cached values that it
        // may maintain.
        Console.WriteLine("Encoder Setting updated {0}", encoder.Name());
    }
    public override void StatusEvent(EncoderStatusInfo statusInfo, EdgeVisDecoderSDK.Encoder encoder)
    {
        // This method is called when an event has occured at the specified encoder.
        // For example, environmental alerts such as low battery, high Voltage or
        // low temperature.
        // This can also be called to indicate that an RDC event has occurred at the 
        // encoder (if configured).
        Console.WriteLine("Encoder Status event {0}", encoder.Name());
        // Get on to another thread from the callback here - doing too much processing on 
        // the callback thread may delay the decode
        Task.Run(() => AsyncProcessStatusEvent(statusInfo, encoder));
    }
    private void AsyncProcessStatusEvent(EncoderStatusInfo statusInfo, EdgeVisDecoderSDK.Encoder encoder)
    {
        if (statusInfo.IsValid() && encoder.IsValid())
        {
            // the EncoderStatusInfo class provides a DisplayString as a convenience for 
            // describing the contents of the event
            string displayString = statusInfo.DisplayString();
            Console.WriteLine("Status event received for {0} :", encoder.Name());
            Console.WriteLine(displayString);
            // to obtain the raw parameter contents associated with the event use the Params() method.
            ParamsMap eventParams = statusInfo.Params();
            // the timestamp of the event can be retrieved as follows:
            long timestamp = statusInfo.TimeStamp();
        }
    }
}

Register for the encoder listener

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

Process the encoder call backs

private class SDKEncoderListener extends IEncoderListener {
  @Override
  public void SettingsUpdated(EncoderSettingsChangeInfo eventInfo, Encoder encoder) {
    // This method is called when the encoder has had its settings modified by another client.
    // The changes to the encoder's configuration are applid to the SDK internally.  The client
    // application should obtain these from the SDK again to update any cached values that it
    // may maintain.
    Log.i(TAG,"Encoder Setting updated " + encoder.Name());
  }
  @Override
  public void StatusEvent(final EncoderStatusInfo statusInfo, final Encoder encoder) {
    // This method is called when an event has occured at the specified encoder.
    // For example, environmental alerts such as low battery, high Voltage or
    // low temperature.
    // This can also be calle dto indicate that an RDC event has occurred at the
    // encoder (if configured).
    Log.i(TAG,"Encoder Status event " + encoder.Name());
    // Get on to another thread from the callback here - doing too much processing on
    // the callback thread may delay the decode
    new Thread(new Runnable() {
      @Override
      public void run() {
        doProcessStatusEvent(statusInfo, encoder);
      }
    }).start();
  }
}
private void doProcessStatusEvent(EncoderStatusInfo statusInfo, Encoder encoder) {
  if (statusInfo != null && encoder != null && statusInfo.IsValid() && encoder.IsValid())
  {
    // the EncoderStatusInfo class provides a DisplayString as a convenience for
    // describing the contents of the event
    String displayString = statusInfo.DisplayString();
    Log.i(TAG,"Status event received for " + encoder.Name() + ": " + displayString);
    // to obtain the raw parameter contents associated with the event use the Params() method.
    ParamsMap params = statusInfo.Params();
    // the timestamp of the event can be retrieved as follows:
    long timestamp = statusInfo.TimeStamp();
  }
}