Photon C++ Client API  5.0.7.3
Public Member Functions | List of all members
LocalVoiceFramed< T > Class Template Reference

Typed re-framing LocalVoice More...

Inheritance diagram for LocalVoiceFramed< T >:
Inheritance graph
[legend]

Public Member Functions

int getFrameSize (void) const
 
void addPostProcessor (Common::Helpers::SharedPointer< IProcessor< T > > processor)
 Adds the processor that is provided as a parameter after any built-in processors and everything added with addPreProcessor(). More...
 
void addPreProcessor (Common::Helpers::SharedPointer< IProcessor< T > > processor)
 Adds the processor that is provided as a parameter before the built-in processors and everything added with addPostProcessor(). More...
 
void clearProcessors (void)
 Clears all processors in pipeline including built-in resampling. User should add at least resampler processor after call. More...
 
bool isPushDataAsyncReady (void)
 Wether this LocalVoiceFramed has capacity for more data buffers to be pushed asynchronously. More...
 
void pushDataAsync (const Buffer< T > &buf)
 Asynchronously push data into this stream. More...
 
void pushData (const Buffer< T > &buf)
 Synchronously push data into this stream. More...
 

Detailed Description

template<typename T>
class ExitGames::Voice::LocalVoiceFramed< T >

Typed re-framing LocalVoice

Consumes data in array buffers of arbitrary length. Repacks them in frames of constant length for further processing and encoding.

Parameters
voiceInfoOutgoing stream parameters. Set applicable fields to read them by encoder and by receiving client when voice created.
channelIdTransport channel specific to transport.
encoderEncoder producing the stream.
Returns
Outgoing stream handler.

Member Function Documentation

◆ addPostProcessor()

void addPostProcessor ( Common::Helpers::SharedPointer< IProcessor< T > >  processor)

Adds the processor that is provided as a parameter after any built-in processors and everything added with addPreProcessor().

Parameters
processor

◆ addPreProcessor()

void addPreProcessor ( Common::Helpers::SharedPointer< IProcessor< T > >  processor)

Adds the processor that is provided as a parameter before the built-in processors and everything added with addPostProcessor().

Parameters
processor

◆ clearProcessors()

void clearProcessors ( void  )

Clears all processors in pipeline including built-in resampling. User should add at least resampler processor after call.

◆ isPushDataAsyncReady()

bool isPushDataAsyncReady ( void  )

Wether this LocalVoiceFramed has capacity for more data buffers to be pushed asynchronously.

◆ pushDataAsync()

void pushDataAsync ( const Buffer< T > &  buf)

Asynchronously push data into this stream.

◆ pushData()

void pushData ( const Buffer< T > &  buf)

Synchronously push data into this stream.