Photon C++ Client API  5.0.7.3
Public Member Functions | Static Public Attributes | List of all members
Encoder< T > Class Template Reference
Inheritance diagram for Encoder< T >:
Inheritance graph
[legend]
Collaboration diagram for Encoder< T >:
Collaboration graph
[legend]

Public Member Functions

 Encoder (const VoiceInfo &info, const ILogger &logger)
 
virtual Common::JString getError (void) const
 If not null, the object is in invalid state. More...
 
virtual void setOutput (void *opaque, void(*output)(void *, const Buffer< nByte > &))
 Set callback encoder calls on each encoded data frame (if such output supported). More...
 
virtual Buffer< nByte > dequeueOutput (void)
 Returns next encoded data frame (if such output supported). More...
 
virtual void input (const Buffer< T > &buf)
 Consumes the given raw data. More...
 

Static Public Attributes

static const int RECOMMENDED_MAX_PACKET_SIZE
 

Member Function Documentation

◆ getError()

JString getError ( void  ) const
virtual

If not null, the object is in invalid state.

Implements IEncoder.

◆ setOutput()

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

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

Implements IEncoder.

◆ dequeueOutput()

virtual Buffer<nByte> dequeueOutput ( void  )
virtual

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

Implements IEncoder.

◆ input()

void input ( const Buffer< T > &  buf)
virtual

Consumes the given raw data.

Parameters
bufArray containing raw data (e.g. audio samples).

Implements IEncoderDirect< Buffer< T > >.