Movie Playback

SetMoviePlaybackSetting

Overview

Set the streaming destination host PC information on the camera at movie playback.

See “Movie Playback” for usage instructions.

Definition

CrError SetMoviePlaybackSetting(CrDeviceHandle deviceHandle, CrMoviePlaybackSetting* setting, CrInt32u numOfSetting);

Input parameters

Type

Explanation

CrDeviceHandle

deviceHandle

CrMoviePlaybackSetting*

setting

CrInt32u

numOfSetting
1 fixed. In version 1.13.00, multiple information cannot be set.
Output parameters

None

Return value

Type

Explanation

CrError

CrError_None on Success
Other than errors above, see Status code & Error
Related API
Special note (details)

None in particular

GetMoviePlaybackSetting

Overview

Get the information of the destination host PC set with SetMoviePlaybackSetting().

See “Movie Playback” for usage instructions.

Definition

CrError GetMoviePlaybackSetting(CrDeviceHandle deviceHandle, CrMoviePlaybackSetting** setting, CrInt32u* numOfSetting);

Input parameters

Type

Explanation

CrDeviceHandle

deviceHandle

Output parameters

Type

Explanation

CrMoviePlaybackSetting**

setting
The CrMoviePlaybackSetting list pointer. Developers should pass the address of a modifiable CrMoviePlaybackSetting pointer. The value of this pointer should be initialized to nullptr. Copy the Monitoring setting information stored inside the SDK-internal after the success of SetMoviePlaybackSetting() to this pointer.

CrInt32u

numOfSetting
An integer pointer that indicates the number of CrMoviePlaybackSetting returned by the list pointer.
Developers should pass the address of a modifiable CrInt32u variable.

Return value

Type

Explanation

CrError

CrError_None on Success
Other than errors above, see Status code & Error
Related API
Special note (details)

None in particular

ReleaseMoviePlaybackSetting

Overview

This function releases the CrMonitoringDeliverySetting allocated by GetMoviePlaybackSetting().

See “Movie Playback” for usage instructions.

Definition

CrError ReleaseMoviePlaybackSetting(CrDeviceHandle deviceHandle, CrMoviePlaybackSetting* setting);

Input parameters

Type

Explanation

CrDeviceHandle

deviceHandle

CrMoviePlaybackSetting*

Setting
CrMoviePlaybackSetting list pointer to release.
Output parameters

None

Return value

Type

Explanation

CrError

CrError_None on Success
Other than errors above, see Status code & Error
Related API
Special note (details)

None in particular

ControlMoviePlayback

Overview

Control streaming of movie at movie playback.

See “Movie Playback” for usage instructions.

Definition

CrError ControlMoviePlayback(CrDeviceHandle deviceHandle, CrMoviePlaybackControlType operationMode, CrInt32u seekPosition = 0);

Input parameters

Type

Explanation

CrDeviceHandle

deviceHandle

CrMoviePlaybackControlType

operationMode
Specify the operation type of streaming. Use CrMoviePlaybackControlType defined in CrDefines.h.

CrInt32u

seekPosition.
Only required when you specify CrMoviePlaybackControlType_Seek to operationMode.
Specify the seek position. (1/100 sec)
You should set the value between movie duration.
Output parameters

None

Return value

Type

Explanation

CrError

CrError_None on Success
Other than errors above, see Status code & Error
Related API
Special note (details)

This API can be executed when either one of the below Device Property, which has target content is in Enable:

RequestMoviePlaybackStatus

Overview

Request movie playback status.

This API only available during execute movie playback function.

See “Movie Playback” for usage instructions.

Definition

CrError RequestMoviePlaybackStatus(CrDeviceHandle deviceHandle);

Input parameters

Type

Explanation

CrDeviceHandle

deviceHandle

Output parameters

None

Return value

Type

Explanation

CrError

CrError_None on Success
Other than errors above, see Status code & Error
Related API
Special note (details)

The result of this API will be notified by OnWarning(). When OnWarning notifies you of “ CrNotify_PlayBack_Result_PlaybackInfo_Success”, you can get the status with GetMoviePlaybackStatus().

GetMoviePlaybackStatus

Overview

It is an API to get the movie playback status. It can only be executed if RequestMoviePlaybackStatus() is successful.

See “Movie Playback” for usage instructions.

Definition

CrError GetMoviePlaybackStatus(CrDeviceHandle deviceHandle, CrMoviePlaybackStatus* playbackStatus);

Input parameters

Type

Explanation

CrDeviceHandle

deviceHandle

Output parameters

Type

Explanation

CrMoviePlaybackStatus*

playbackStatus
Caution: This value is not real time value.

Return value

Type

Explanation

CrError

CrError_None on Success
Other than errors above, see Status code & Error
Related API
Special note (details)

None in particular