OVR_Platform_Internal.h File

( const char * requestURIPrefix,

const char * accessToken )

( const char * accessToken )

( ovrPermissionType permType )

( ovrPermissionType permType )

( const ovrMessageHandle obj )

( const ovrSystemPermissionHandle obj )

( const ovrSystemPermissionHandle obj )

( const char * eventName,

const ovrPlatformLogValue * values,

size_t length )

( const ovrPlatformLogValue * values,

size_t length )

( ovrLogEventName eventName,

const ovrPlatformLogValue * values,

size_t length )

( ovrLogEventName eventName,

const ovrPlatformLogValue * values,

size_t length )

( ovrVoipCodecOptionsHandle options )

( VoipFilterCallback cb,

size_t bufferSizeElements )

( ovrLivestreamHeadphoneStatus status )

( const char * endpoint,

const char * token,

const char * session,

int videoHeight,

int videoWidth,

int videoFps,

int videoMaxBitrateKbps,

bool enableJsonDataChannel )

( ovrLivestreamHeadphoneStatus status )

( bool isMounted )

( bool isInTuneInMode )

( bool disabled )

( bool passthrough )

( bool passthrough )

( bool suppressed )

( ovrID * peers,

size_t size )

( ovrVoipMuteState muted )

( ovrID userId )

Deprecated: Returns a null video track.

( ovrID * participants,

size_t size )

Deprecated: Will always return 0.

( int16_t * pcmData,

size_t pcmDataLength,

int frequency,

int numChannels,

float volume,

int64_t trackID,

int bitsPerSample )

( bool muted )

( float scaleFactor )

( float volume )

( ovrID participantID )

( ovrID participantID )

( bool passthrough )

( ovrVoipMuteState muted )

( const char * packageName )

( bool isVisible )

( ovrLivestreamMicStatus status )

( int16_t * pcmData,

size_t pcmDataLength,

int frequency,

int numChannels,

float volume,

int64_t trackID,

int bitsPerSample )

( bool isAvailable )

( ovrID uid,

int16_t * outputBuffer,

size_t outputBufferSizeElements )

( ovrID uid )

( ovrID uid )

( ovrID uid )

( ovrID uid )

( LogFunctionPtr logFunc )

( const char * appId )

( LogFunctionPtr logptr )

( const char * appId )

( const char * url,

int messageType )

( const char * appID,

LogFunctionPtr logptr )

( ovrCaptureredAudioRendererHandle object )

( ovrCaptureredAudioRendererHandle object,

int16_t * pcmData,

size_t pcmDataLength,

int frequency,

int numChannels,

float volume,

int64_t trackID,

int bitsPerSample )

( ovrCaptureredAudioRendererHandle object,

int16_t * outputBuffer,

size_t outputBufferLength,

int frequency,

int numChannel )

( ovrConfigOptionInternal config,

int value )

( ovrConfigOptionInternal configOption )

( ovrID content_id,

ovrAdvancedAbuseReportOptionsHandle abuse_report_options )

( unsigned long long appID,

unsigned long long roomID )

( const char * avatarMetaData,

const char * imageFilePath )

( const char * uuid )

( const char * uuid )

( const char * challenge_nonce )

( const char * url )

( const char * url )

( const char * url )

( const char * url,

const char * diskFile )

( const char * url,

const char * filepath_param_name,

const char * filepath,

const char * access_token,

ovrKeyValuePair * post_params,

unsigned int numItems )

( const char * url )

( const char * url,

ovrKeyValuePair * headers,

size_t count )

( ovrRequest transferId,

const void * bytes,

size_t length )

Writes data to the stream identified by a given `transferId'.

( ovrRequest transferId )

( const char * endpoint,

const char * token,

const char * session )

Initializes a connection via a custom HTTP endpoint.

( const char * endpoint,

const char * token,

const char * session,

int videoWidth,

int videoHeight,

int videoFps,

int videoMaxBitrateKbps )

( const char * endpoint,

const char * token,

const char * session,

int videoHeight,

int videoWidth,

int videoFps,

int videoMaxBitrateKbps,

bool enableTurnServer,

bool enableTcpTurnServer,

bool enableAssembleOfferWhileTrickleIce )

Initializes a cast connection with turn servers options.

( const char * endpoint,

const char * token,

const char * session,

int videoHeight,

int videoWidth,

int videoFps )

( const char * endpoint,

const char * token,

const char * session,

int videoHeight,

int videoWidth,

int videoFps,

int videoMaxBitrateKbps )

( const char * endpoint,

const char * token,

const char * session,

int videoHeight,

int videoWidth,

int videoFps,

bool enableJsonDataChannel )

( const char * fbAccessToken,

ovrID streamID )

( const char * jsonString )

Send data to livestream webrtc data channel.

( const char * packageName )

Starts a livestream to streamID from packageName.

Stops the current livestream.

( const char * packageName )

( ovrLivestreamingAudience audience,

ovrLivestreamingMicrophoneStatus micStatus )

( ovrLivestreamingMicrophoneStatus micStatus )

( ovrMessageHandle message )

( ovrNetSyncOptionsHandle connect_options )

( long long connection_id )

( long long connection_id )

( long long connection_id )

( long long connection_id,

const float * distances,

const float * decibels,

size_t count )

( long long connection_id,

const char * name,

const float * distances,

const float * decibels,

size_t count )

( long long connection_id,

const char * channel_name,

const char * attnmodel,

bool disable_spatialization )

( long long connection_id,

const char * group_id )

( long long connection_id,

const char ** listento_channels,

size_t count )

( long long connection_id,

ovrNetSyncVoipMicSource mic_source )

( long long connection_id,

ovrID session_id,

bool muted )

( long long connection_id,

const char ** speakto_channels,

size_t count )

( long long connection_id,

ovrID sessionId,

ovrNetSyncVoipStreamMode streamMode )

( long long connection_id,

float * outputBuffer,

size_t outputBufferNumElements )

( long long connection_id,

int16_t * outputBuffer,

size_t outputBufferNumElements )

( long long connection_id,

float * outputBuffer,

size_t outputBufferNumElements )

( long long connection_id,

int16_t * outputBuffer,

size_t outputBufferNumElements )

( long long connection_id,

ovrID sessionId,

ovrNetSyncVec3 * position )

( long long connection_id,

ovrID sessionId,

float * outputBuffer,

size_t outputBufferNumElements )

( long long connection_id,

ovrID session_id,

int16_t * outputBuffer,

size_t outputBufferNumElements )

( long long connection_id,

ovrID sessionId,

float * amplitude )

( long long connection_id,

const ovrNetSyncVec3 * position )

( ovrID partyID,

ovrID appID )

( ovrID partyID )

( ovrID userID )

( ovrID partyID,

ovrID userID )

( ovrID partyID )

( ovrID partyID )

( ovrID userId,

int16_t * buffer,

size_t numElements,

uint32_t * timestamp )

( const char * packageName )

( ovrID partyId )

( ovrID partyId )

Sends a request to the system to start party chat.

Sends a request to the system to stop party chat.

( const char * api_name )

( bool is_joinable )

( const char * id )

( const char * id )

( const char * recordingUUID )

( ovrUserOptionsHandle userOptions )

( ovrID userID )

( ovrID optionalUserID,

ovrAbuseReportOptionsHandle abuseReportOptions )

( ovrID optionalUserID,

const char * optionalRecordingUUID )

( ovrID optionalUserID,

const char * optionalRecordingUUID,

ovrAbuseReportOptionsHandle abuseReportOptions )

( const char * deviceID,

ovrID * appIDs,

int numAppIDs )

( unsigned long long * sessionIDs )

Deprecated: Returns a null video track.

Deprecated: Will always return 0.

Initiates an HTTP transfer to a given URL. Returns an id that can be used to write data to the stream. A message will be posted when new data is received or in case of an error.

Writes data to the stream identified by a given `transferId'.

Indicates that the no more data will be sent to the server. The connection will eventually be closed. Note that we might still receive data from the server for a little while.

Initializes a connection via a custom HTTP endpoint.

Initializes a connection via a custom HTTP endpoint with video spec and bitrate parameters

Initializes a cast connection with turn servers options.

Initializes a connection via a custom HTTP endpoint with video spec parameters (use default max bitrate to 3000 kbps)

Initializes a connection via a custom HTTP endpoint with video spec and bitrate parameters

Initializes a connection via a custom HTTP endpoint with video spec and data channel parameters (use default max bitrate to 3000 kbps)

Initializes a connection to the MWS with a Facebook UID and FBUID/Oculus FB App access token

Send data to livestream webrtc data channel.

Starts a livestream to streamID from packageName.

Stops the current livestream.

returns a json formatted string to be sent to javascript / ReactVR it is populated by the public CAPI, so that we don't increase our compatibility surface. It's always a json array with a single json object inside of it. The only key will always be data/error. The keys are defined to be the same as in models.yaml so we can codegen easily.

Gets all available samples of ambisonic mixed voice data and copies it into outputBuffer. Returns the number of frames copied.

This function can be safely called from any thread.

Gets all available samples of ambisonic mixed voice data and copies it into outputBuffer. Returns the number of frames copied.

This function can be safely called from any thread.

Gets all available samples of ambisonic mixed voice data and copies it into outputBuffer. Returns the number of frames copied.

This function can be safely called from any thread.

Gets all available samples of ambisonic mixed voice data and copies it into outputBuffer. Returns the number of frames copied.

This function can be safely called from any thread.

Populates the given 3 element array with the position of the given session. If the given session has never called set_listener_position, or if the position has not yet been replicated, this method will set each to { 0, 0, 0 }

The coordinate system used for ambisonic mixing is as right handed: positive X pointing right, positive Y pointing upward, positive Z pointing backward

A value of 1.0 is equal to 1 meter.

Gets all available samples of monostream voice data for the given networking session identifier and copies it into outputBuffer. Returns the number of frames copied.

This function can be safely called from any thread.

Gets all available samples of monostream voice data for the given networking session identifier and copies it into outputBuffer. Returns the number of frames copied.

This function can be safely called from any thread.

Returns the maximum number of samples that an output buffer will need to hold.

gets the voip amplitude of other sessions. the amplitude range is from [0.0f, 1.0f]

when successfully set the function returns true, else false.

Sets the position of the listener for spatialized audio, which is used to mix the ambisonic stream on the server. This is also used as the position for the microphone.

This internal-only method is used by the platform plugin to extract audio frames for a given user. See ovr_Voip_GetPCMWithTimestamp() for details.

Returns a handle to a shared memory object that can be used to receive pcm data in passthrough mode.

Internal use only. Noop if called from a 3P app context. Gets party chat microphone mute status.

Internal use only. Noop if called from a 3P app context. Returns true if we are in voip passthrough mode.

Internal use only. Noop if called from a 3P app context. Gets party chat status.

This internal-only method is used by the platform plugin in order to enable video streaming to the party.

This internal-only method is called by the platform plugin in order to set up a conference call with all members of the given party.

This internal-only method is used by the platform plugin in order to disable video streaming to the party.

This internal-only method is called by the platform plugin after leaving the party in order to stop the conference call.

Sends a request to the system to start party chat.

Sends a request to the system to stop party chat.