EdgeVisDecoderSDK::IFullResListener Class Referenceabstract

Detailed Description

The interface for the Full resolution service callbacks.

Threads

Care should be taken with threading within the EdgeVis SDK.

  • Callbacks from the SDK must not be blocked. Any processing resulting in a callback must be passed to a separate thread in your application and the callback complete as soon as possible
  • Callbacks from the SDK must not call back into the SDK on the same thread. Call back into the SDK on a separate thread.

Availability

Available in version 6.0 of Decoder SDK. Requires a server version greater than 6.0

#include <IFullResListener.h>

Public Member Functions

virtual void AvailableFramesListReady (std::vector< int64_t > frame_list)=0
 Called when the service has been started and the list of available frames has been calculated. More...
 
virtual void YCbCrFrameReady (int64_t timestamp)=0
 Called when a YCbCr frame has been created for the selected frame. More...
 
virtual void YCbCrFrameUpdated (int64_t timestamp, int32_t percent_done)=0
 Called when data is received from a stream and the image portion has been inserted into the frame. More...
 
virtual void FullResInUse (std::wstring users_name)=0
 Called in response to the service start if the service is already in use. More...
 
virtual void FullResOpenFailed ()=0
 Called if the Start command failed.
 
virtual void FullResLinkLost ()=0
 Called if the Full Resolution service has failed due to a network error.
 
virtual void FullResKicked ()=0
 Called if the Full Resolution service has been kicked by a system administrator.
 
virtual void FullResTimedOut ()=0
 Called if the Full Resolution service has been closed due to the MediaStream viewer time out expiring.
 

Member Function Documentation

virtual void EdgeVisDecoderSDK::IFullResListener::AvailableFramesListReady ( std::vector< int64_t >  frame_list)
pure virtual

Called when the service has been started and the list of available frames has been calculated.

If no frames are available this will send 0.

Parameters
frame_listA list of available frame indices.
virtual void EdgeVisDecoderSDK::IFullResListener::YCbCrFrameReady ( int64_t  timestamp)
pure virtual

Called when a YCbCr frame has been created for the selected frame.

This is in response to the FullResService::SetActiveFrame()

Parameters
timestampThe frame index
virtual void EdgeVisDecoderSDK::IFullResListener::YCbCrFrameUpdated ( int64_t  timestamp,
int32_t  percent_done 
)
pure virtual

Called when data is received from a stream and the image portion has been inserted into the frame.

This will be called every time a 'chunk' of the image has been retrieved. Will be called in response to FullResService::EnhanceArea() or FullResService::EnhanceEntireFrame().

Parameters
timestampThe frame index
percent_doneThe percentage complete from 0 to 100.
virtual void EdgeVisDecoderSDK::IFullResListener::FullResInUse ( std::wstring  users_name)
pure virtual

Called in response to the service start if the service is already in use.

Parameters
users_nameThe name of the user using the service.

The documentation for this class was generated from the following file: