plv player sdk doc
Loading...
Searching...
No Matches
Typedefs | Functions
Deprecated Api

Typedefs

typedef void(* OnRequestVideoInfoHandler) (int code, const PLVVideoRequestInfo infos[], int infosNum, const PLVVideoRequestPageInfo *pageInfo, void *data)
 request video info callback.
 
typedef void(* OnPlayerAudioDeviceHandler) (int audioDeviceCount, void *data)
 the player audio device list change.
 

Functions

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkHttpRequest (SDK_HTTP_REQUEST type)
 for thd sdk http request type.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkCacertFile (const char *fileName)
 set upload ca file, if use https, must set the ca file, otherwise error.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVRequestVideoInfo (bool sync, const PLVVideoRequestParam *param, OnRequestVideoInfoHandler handler, void *data)
 request video info.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVCancelRequestVideoInfo ()
 cancel request video info.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVMigrateLocalVideoKeyFile (const char *keyFilePath, const char *secretKey)
 migrate old encryption key to use token encryption key.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetAudioDeviceHandler (PLVPlayerPtr player, OnPlayerAudioDeviceHandler handler, void *data)
 for play audio device list callback.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetAudioDeviceCount (PLVPlayerPtr player)
 get audio device count.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetAudioDeviceInfo (PLVPlayerPtr player, int index, char deviceId[PLV_MAX_DEVICE_ID_LENGTH], char deviceName[PLV_MAX_DEVICE_ID_LENGTH])
 the audio device info.
 
PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerReloadAudioDevice (PLVPlayerPtr player)
 reload the audio device.
 

Detailed Description

Typedef Documentation

◆ OnPlayerAudioDeviceHandler

typedef void(* OnPlayerAudioDeviceHandler) (int audioDeviceCount, void *data)

the player audio device list change.

Deprecated
Parameters
[out]audioDeviceCountaudio device count.
[out]datauser context data.

Definition at line 87 of file plv-player-deprecated.h.

◆ OnRequestVideoInfoHandler

typedef void(* OnRequestVideoInfoHandler) (int code, const PLVVideoRequestInfo infos[], int infosNum, const PLVVideoRequestPageInfo *pageInfo, void *data)

request video info callback.

Deprecated
Suggest requesting video information on the server
Parameters
[out]coderequest result code
[out]infosvideo infos.
[out]infosNumvideo infos number.
[out]pageInfopage info, if user request in page.
[out]datauser context.

Definition at line 40 of file plv-player-deprecated.h.

Function Documentation

◆ PLVCancelRequestVideoInfo()

PLAYERSDK_API int PLAYERSDK_CALL PLVCancelRequestVideoInfo ( )

cancel request video info.

Deprecated
Suggest requesting video information on the server
Returns
  • 0: Success.
  • > 0: Failure.
Note
need SDK init.

◆ PLVMigrateLocalVideoKeyFile()

PLAYERSDK_API int PLAYERSDK_CALL PLVMigrateLocalVideoKeyFile ( const char * keyFilePath,
const char * secretKey )

migrate old encryption key to use token encryption key.

Deprecated
Suggest new token API.
Parameters
keyFilePathkey file path, use UTF8.
secretKeyold secret key.
Returns
  • 0: Success.
  • > 0: Failure.
Attention
path must use UTF8.
Note
need SDK init.

◆ PLVPlayerGetAudioDeviceCount()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetAudioDeviceCount ( PLVPlayerPtr player)

get audio device count.

Deprecated
See also
PLVGetAudioDeviceCount
Parameters
playerthe player object, for PLVPlayerCreate return.
See also
PLVPlayerCreate.
Returns
  • >=0 audio device count.

◆ PLVPlayerGetAudioDeviceInfo()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerGetAudioDeviceInfo ( PLVPlayerPtr player,
int index,
char deviceId[PLV_MAX_DEVICE_ID_LENGTH],
char deviceName[PLV_MAX_DEVICE_ID_LENGTH] )

the audio device info.

deprecated

See also
PLVGetAudioDeviceInfo
Parameters
playerthe player object, for PLVPlayerCreate return.
See also
PLVPlayerCreate.
Parameters
indexaudio device index.
[out]deviceIdaudio device id.
[out]deviceNameaudio device name.
Returns
  • 0: Success.
  • > 0: Failure.

◆ PLVPlayerReloadAudioDevice()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerReloadAudioDevice ( PLVPlayerPtr player)

reload the audio device.

Deprecated
No need to call temporarily
Parameters
playerthe player object, for PLVPlayerCreate return.
See also
PLVPlayerCreate.
Note
If there is no original audio device, it needs to reload the audio after new insertion!
Returns
  • 0: Success.
  • > 0: Failure.

◆ PLVPlayerSetAudioDeviceHandler()

PLAYERSDK_API int PLAYERSDK_CALL PLVPlayerSetAudioDeviceHandler ( PLVPlayerPtr player,
OnPlayerAudioDeviceHandler handler,
void * data )

for play audio device list callback.

Deprecated
Parameters
playerthe player object, for PLVPlayerCreate return.
See also
PLVPlayerCreate.
Parameters
handlercallback function.
datauser context data.
Returns
  • 0: Success.
  • > 0: Failure.

◆ PLVRequestVideoInfo()

PLAYERSDK_API int PLAYERSDK_CALL PLVRequestVideoInfo ( bool sync,
const PLVVideoRequestParam * param,
OnRequestVideoInfoHandler handler,
void * data )

request video info.

Deprecated
Suggest requesting video information on the server
Parameters
syncuse sync or asynchronous.
paramrequest param.
handlercallback function.
datauser context.
Returns
  • 0: Success.
  • > 0: Failure.
Note
need SDK init.

◆ PLVSetSdkCacertFile()

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkCacertFile ( const char * fileName)

set upload ca file, if use https, must set the ca file, otherwise error.

Deprecated
Not recommended to set the CA certificate path
Parameters
fileNamethe ca file,include path. use UTF8.
Returns
  • 0: Success.
  • > 0: Failure.
Note
if not have call, will find in app path.
Attention
path must use UTF8

◆ PLVSetSdkHttpRequest()

PLAYERSDK_API int PLAYERSDK_CALL PLVSetSdkHttpRequest ( SDK_HTTP_REQUEST type)

for thd sdk http request type.

Deprecated
Not recommended to set the HTTP request type
Parameters
typehttp protocol first request type.
See also
ONLY_HTTPS_REQUEST.
Returns
  • 0: Success.
  • > 0: Failure.
Note
default value for ONLY_HTTPS_REQUEST.