Photon C++ Client API  5.0.7.3
Public Member Functions | List of all members
IEncoder Class Referenceabstract

Generic encoder interface. More...

Inheritance diagram for IEncoder:
Inheritance graph
[legend]

Public Member Functions

virtual Common::JString getError (void) const =0
 If not null, the object is in invalid state. More...
 
virtual void setOutput (void *opaque, void(*output)(void *, const Buffer< nByte > &))=0
 Set callback encoder calls on each encoded data frame (if such output supported). More...
 
virtual Buffer< nByte > dequeueOutput ()=0
 Returns next encoded data frame (if such output supported). More...
 

Detailed Description

Generic encoder interface.

Depending on implementation, encoder should either call Output on eaach data frame or return next data frame in DequeueOutput() call.

Member Function Documentation

◆ getError()

virtual Common::JString getError ( void  ) const
pure virtual

If not null, the object is in invalid state.

Implemented in UnsupportedCodecError, and Encoder< T >.

◆ setOutput()

virtual void setOutput ( void *  opaque,
void(*)(void *, const Buffer< nByte > &)  output 
)
pure virtual

Set callback encoder calls on each encoded data frame (if such output supported).

Implemented in UnsupportedCodecError, and Encoder< T >.

◆ dequeueOutput()

virtual Buffer<nByte> dequeueOutput ( )
pure virtual

Returns next encoded data frame (if such output supported).

Implemented in UnsupportedCodecError, and Encoder< T >.