EdgeVisDecoderSDK::IGOPDownloadListener Class Referenceabstract

Detailed Description

The interface for the GOP download service callbacks.

This will return the GOPDataBlock containing the data extraced from the remote archive.

Each GOPDataBlock has a GOPDataBlockType indicating the type of data extraced, i.e a Video frame or an SDP (Session Description Protocol) block describing the Video or Audio data block.

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.1 of Decoder SDK. Requires a server version greater than 6.6

#include <IGOPDownloadListener.h>

Public Member Functions

virtual void GOPDownloadComplete ()=0
 Called when the requested download is complete.
 
virtual void GOPDownloadDataAvailable (GOPData data)=0
 Called when a section of the requested GOP data is available. More...
 
virtual void GOPDownloadProgress (int32_t percent)=0
 Called when a progress update is available for the download in the range 0 - 100. More...
 
virtual void GOPDownloadOpenComplete ()=0
 Called in response to the service starting successfully, or when the conenction to the encoder has been re-established. More...
 
virtual void GOPDownloadInUse (std::wstring users_name)=0
 Called in response to the service start if the service is already in use. More...
 
virtual void GOPDownloadOpenFailed ()=0
 Called if the Start command failed.
 
virtual void GOPDownloadLinkLost ()=0
 Called if the GOP download service has failed due to a network error.
 
virtual void GOPDownloadFailed (OpResult error)=0
 Called if the GOP download fails while in progress.
 

Member Function Documentation

virtual void EdgeVisDecoderSDK::IGOPDownloadListener::GOPDownloadDataAvailable ( GOPData  data)
pure virtual

Called when a section of the requested GOP data is available.

The GOP data watermark is verified before this method is called.

Parameters
dataThe section of the requested GOP data that has been successfully downloaded.
virtual void EdgeVisDecoderSDK::IGOPDownloadListener::GOPDownloadProgress ( int32_t  percent)
pure virtual

Called when a progress update is available for the download in the range 0 - 100.

Parameters
percentThe approximate percentage of the total download requested.
virtual void EdgeVisDecoderSDK::IGOPDownloadListener::GOPDownloadOpenComplete ( )
pure virtual

Called in response to the service starting successfully, or when the conenction to the encoder has been re-established.

A download may be requested after this callback has been called.

virtual void EdgeVisDecoderSDK::IGOPDownloadListener::GOPDownloadInUse ( 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: