plv-player-core.h File Reference

Go to the source code of this file.

Typedefs
typedef void(*	OnLogMessageHandler) (LOG_FILTER_TYPE level, const char *message, void *data)
	log message callback.
typedef void(*	OnRequestVideoInfoHandler) (int code, const PLVVideoRequestInfo infos[], int infosNum, const PLVVideoRequestPageInfo *pageInfo, void *data)
	request video info callback.
typedef void(*	OnDetectSoftwareRecordingHandler) (SOFTWARE_RECORDING_NOTIFY_TYPE type, const char *softwares, void *data)
	for detect softward recording callback.
typedef void(*	OnDetectHardwareRecordingHandler) (DEVICE_CHANGED_TYPE type, const char *device, void *data)
	for detect device recording callback.
typedef void *	PLVPlayerPtr
	player object type.
typedef bool(*	OnPlayerVideoFrameHandler) (const char *vid, PLVVideoFrame *frame, void *data)
	player video frame.
typedef void(*	OnPlayerStateHandler) (const char *vid, int state, void *data)
	player media state.
typedef void(*	OnPlayerPropertyHandler) (const char *vid, int property, int format, const char *value, void *data)
	player media property value.
typedef void(*	OnPlayerRateChangeHandler) (const char *vid, int inputRate, int realRate, void *data)
	the player rate change.
typedef void(*	OnPlayerProgressHandler) (const char *vid, int millisecond, void *data)
	the player play media progress.
typedef void(*	OnPlayerAudioDeviceHandler) (int audioDeviceCount, void *data)
	the player audio device list change.

Functions
PLAYERSDK_API const char *PLAYERSDK_CALL	PLVGetSdkVersion (void)
	get the sdk version.
PLAYERSDK_API const char *PLAYERSDK_CALL	PLVGetSdkErrorDescription (int err)
	get the code description.
PLAYERSDK_API bool PLAYERSDK_CALL	PLVCheckFileComplete (const char *vid, const char *videoFilePath, int rate)
	check the video is completed.
PLAYERSDK_API int PLAYERSDK_CALL	PLVSetSdkLogLevel (LOG_FILTER_TYPE level)
	set the sdk log filter level.
PLAYERSDK_API int PLAYERSDK_CALL	PLVSetSdkLogFile (const char *fileName)
	set the sdk log file.
PLAYERSDK_API int PLAYERSDK_CALL	PLVSetSdkLogMessageCallback (bool enable, OnLogMessageHandler handler, void *data)
	for log message callback.
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	PLVSetSdkHwdecEnable (bool enable)
	Hardware coding.
PLAYERSDK_API int PLAYERSDK_CALL	PLVSetSdkKeepLastFrame (bool enable)
	end video will keep in last frame.
PLAYERSDK_API int PLAYERSDK_CALL	PLVSetSdkRetryAttempts (int attempts, int milliseconds, int millisecondsMax)
	download retry count, default unlimit retry
PLAYERSDK_API int PLAYERSDK_CALL	PLVSetSdkVideoOutputDevice (VIDEO_OUTPUT_DEVICE type, const char *context=NULL)
	Video output drivers are interfaces to different video output facilities. If there is no video problem, it is generally not recommended to use.
PLAYERSDK_API int PLAYERSDK_CALL	PLVSetSdkViewerInfo (const char *viewerId, const char *viewerName, const char *viewerAvatar, const char *viewerExtraInfo1=NULL, const char *viewerExtraInfo2=NULL, const char *viewerExtraInfo3=NULL)
	this api will use report qos, recommended settings.
PLAYERSDK_API int PLAYERSDK_CALL	PLVSetSdkLocalRememberPlay (bool enable)
	Set the last playback position for playback.
PLAYERSDK_API int PLAYERSDK_CALL	PLVInitSdkLibrary (const PLVAccountInfo *info)
	init the sdk.
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	PLVDeleteLocalVideoFile (const char *vid, const char *path, int rate)
	delete local video file.
PLAYERSDK_API void PLAYERSDK_CALL	PLVReleaseSdkLibrary (void)
	release sdk.
PLAYERSDK_API int PLAYERSDK_CALL	PLVSetPreventSoftwareRecording (void *window, bool enable)
	for prevent screen recording or screenshot.
PLAYERSDK_API int PLAYERSDK_CALL	PLVGetPreventSoftwareRecording (void *window, bool *enable)
	for prevent screen recording or screenshot.
PLAYERSDK_API int PLAYERSDK_CALL	PLVSetDetectSoftwareRecordingHandler (bool enable, OnDetectSoftwareRecordingHandler handler, void *data)
	for detect software recording your screen or window.
PLAYERSDK_API int PLAYERSDK_CALL	PLVSetDetectHardwareRecordingHandler (bool enable, OnDetectHardwareRecordingHandler handler, void *data)
	for detect device changed callback.
PLAYERSDK_API PLVPlayerPtr PLAYERSDK_CALL	PLVPlayerCreate (void *window)
	Creates the PLVPlayerPtr object and returns the pointer.
PLAYERSDK_API void PLAYERSDK_CALL	PLVPlayerDestroy (PLVPlayerPtr player)
	Destory the PLVPlayerPtr object.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetVideoFrameHandler (PLVPlayerPtr player, OnPlayerVideoFrameHandler lockHandler, OnPlayerVideoFrameHandler unlockHandler, void *data)
	for video frame callback.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetStateHandler (PLVPlayerPtr player, OnPlayerStateHandler handler, void *data)
	for state change callback.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetPropertyHandler (PLVPlayerPtr player, OnPlayerPropertyHandler handler, void *data)
	for property change callback.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetRateChangeHandler (PLVPlayerPtr player, OnPlayerRateChangeHandler handler, void *data)
	for current bit chanage callback, the input rate is VIDEO_RATE_AUTO will callback.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetProgressHandler (PLVPlayerPtr player, OnPlayerProgressHandler handler, void *data)
	for play progress callback.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetAudioDeviceHandler (PLVPlayerPtr player, OnPlayerAudioDeviceHandler handler, void *data)
	for play audio device list callback.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerResetHandler (PLVPlayerPtr player)
	for reset all handler.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetOSDConfig (PLVPlayerPtr player, bool enable, const PLVOsdConfigInfo *config)
	set the video OSD config info
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerGetOSDConfig (PLVPlayerPtr player, PLVOsdConfigInfo &config)
	get the video OSD config info.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetLogoText (PLVPlayerPtr player, bool enable, const PLVLogoTextInfo *config)
	set the video Logo text info
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerGetLogoText (PLVPlayerPtr player, PLVLogoTextInfo &config)
	get the video Logo text info.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetCacheConfig (PLVPlayerPtr player, bool enable, int maxCacheBytes, int maxCacheSeconds)
	set the video cache config info.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerGetCacheConfig (PLVPlayerPtr player, int *maxCacheBytes, int *maxCacheSeconds)
	get the video cache config info.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetInfo (PLVPlayerPtr player, const char *vid, const char *path, int rate)
	set the video info before play.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerPlay (PLVPlayerPtr player, const char *token, int seekMillisecond, bool autoDownRate, bool traceVideo, bool sync)
	play the video.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerPlayLocal (PLVPlayerPtr player, int seekMillisecond, bool autoDownRate)
	play local video, must set the video path.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerLoadLocal (PLVPlayerPtr player, int seekMillisecond, bool autoDownRate)
	load local video, no play, must set the video path.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerPause (PLVPlayerPtr player, bool pause)
	pause the video.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerStop (PLVPlayerPtr player)
	stop the video.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetMute (PLVPlayerPtr player, bool mute)
	set the video mute state.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetSeek (PLVPlayerPtr player, int millisecond)
	seek the play pos.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSeekToEnd (PLVPlayerPtr player)
	stop in end frame.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetVolume (PLVPlayerPtr player, int volume)
	set the video volume.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetVolumeMax (PLVPlayerPtr player, int volume)
	set the video volume gain.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerScreenshot (PLVPlayerPtr player, const char *filename)
	screenshot the play video picture.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetSpeed (PLVPlayerPtr player, double speed)
	Slow down or speed up playback by the factor given as parameter.
PLAYERSDK_API bool PLAYERSDK_CALL	PLVPlayerIsMute (PLVPlayerPtr player)
	the video mute state.
PLAYERSDK_API bool PLAYERSDK_CALL	PLVPlayerIsValid (PLVPlayerPtr player)
	the video have load or idle.
PLAYERSDK_API bool PLAYERSDK_CALL	PLVPlayerIsPause (PLVPlayerPtr player)
	the video play state or pause.
PLAYERSDK_API bool PLAYERSDK_CALL	PLVPlayerIsPlaying (PLVPlayerPtr player)
	the video playing or idle.
PLAYERSDK_API bool PLAYERSDK_CALL	PLVPlayerIsLoaded (PLVPlayerPtr player)
	the video have load or idle.
PLAYERSDK_API bool PLAYERSDK_CALL	PLVPlayerIsLoading (PLVPlayerPtr player)
	the video is loading or idle.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerGetCurrentRateCount (PLVPlayerPtr player)
	the video have rate count.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerGetCurrentRate (PLVPlayerPtr player)
	the video current rate.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerGetVolume (PLVPlayerPtr player)
	the video volume.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerGetDuration (PLVPlayerPtr player)
	the video duration.
PLAYERSDK_API double PLAYERSDK_CALL	PLVPlayerGetSpeed (PLVPlayerPtr player)
	the video speed.
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	PLVPlayerGetCurrentAudioDevice (PLVPlayerPtr player, char deviceId[PLV_MAX_DEVICE_ID_LENGTH])
	the current audio device id.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerSetCurrentAudioDevice (PLVPlayerPtr player, const char deviceId[PLV_MAX_DEVICE_ID_LENGTH])
	set the current audio device.
PLAYERSDK_API int PLAYERSDK_CALL	PLVPlayerReloadAudioDevice (PLVPlayerPtr player)
	reload the audio device.