Photon C++ Client API  5.0.7.3
Classes | Public Member Functions | List of all members
RemoteVoiceOptions Class Reference

Event Actions and other options for a remote voice (incoming stream). More...

Inheritance diagram for RemoteVoiceOptions:
Inheritance graph
[legend]
Collaboration diagram for RemoteVoiceOptions:
Collaboration graph
[legend]

Public Member Functions

void setRemoteVoiceRemoveAction (void *opaque, void(*action)(void *))
 Register a method to be called when the remote voice is removed. More...
 
void setOutput (void *opaque, void(*output)(void *, const Buffer< float > &))
 
void setOutput (void *opaque, void(*output)(void *, const Buffer< short > &))
 
void setOutput (void *opaque, void(*output)(void *, const ImageOutputBuf &))
 
void setOutputImageFormat (ImageFormat::Enum)
 
void setOutputImageFlip (Flip::Enum)
 
void setDecoder (Common::Helpers::SharedPointer< IDecoder > decoder)
 
virtual Common::JStringtoString (Common::JString &retStr, bool withTypes=false) const
 
virtual JStringtoString (JString &retStr, bool withTypes=false) const=0
 
JString toString (bool withTypes=false) const
 
- Public Member Functions inherited from ToString
virtual ~ToString (void)
 
virtual JString typeToString (void) const
 
JString toString (bool withTypes=false) const
 

Detailed Description

Event Actions and other options for a remote voice (incoming stream).

Member Function Documentation

◆ setRemoteVoiceRemoveAction()

void setRemoteVoiceRemoveAction ( void *  pOpaque,
void(*)(void *)  pAction 
)

Register a method to be called when the remote voice is removed.

◆ toString() [1/3]

JString & toString ( Common::JString retStr,
bool  withTypes = false 
) const
virtual
Remarks
The cost of this function depends a lot on implementation details of the implementing subclasses, but for container classes this function can become quite expensive, if the instance contains huge amounts of data, as its cost for many container class implementations increases disproportionately high to the size of the payload.
Parameters
retStrreference to a string, to store the return-value in; the information, which is generated by this function, will be attached at the end of any eventually existing previous content of the string
withTypesset to true, to include type information in the generated string
Returns
a JString representation of the instance and its contents for debugging purposes.

Implements ToString.

◆ toString() [2/3]

toString
Remarks
The cost of this function depends a lot on implementation details of the implementing subclasses, but for container classes this function can become quite expensive, if the instance contains huge amounts of data, as its cost for many container class implementations increases disproportionately high to the size of the payload.
Parameters
retStrreference to a string, to store the return-value in; the information, which is generated by this function, will be attached at the end of any eventually existing previous content of the string
withTypesset to true, to include type information in the generated string
Returns
a JString representation of the instance and its contents for debugging purposes.

◆ toString() [3/3]

JString toString

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters
withTypesset to true, to include type information in the generated string
Returns
a JString representation of the instance and its contents for debugging purposes.
See also
JString