Stream Setting

RequestStreamSettingList

Overview

You can use this API and GetStreamSettingList() to get Stream Setting information.

If you want to use the Stream setting information, first request of this API. Then get information on GetStreamSettingList() after that.

Definition

CrError RequestStreamSettingList(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

• GetStreamSettingList

• IDeviceCallback::OnWarningExt

Special note (details)

This API can be executed when CrDeviceProperty_StreamSettingListOperationStatus is Enable.

When [Access Authen.] is set to [Off] at the camera body, communication is performed without SSH connection authentication or encryption, so the content may be intercepted, or the camera may be accessed by an unintended third party.

GetStreamSettingList

Overview

It is an API to get the Stream setting information. It can only be executed if RequestStreamSettingList() is successful.

Definition

CrError GetStreamSettingList(CrDeviceHandle deviceHandle, CrVideoStreamSetting** list, CrInt32u* numOfList);

Input parameters

Type	Explanation
CrDeviceHandle	deviceHandle

Output parameters

Type	Explanation
CrVideoStreamSetting**	list The CrVideoStreamSetting list pointer. Developers should pass the address of a modifiable CrVideoStreamSetting pointer. The value of this pointer should be initialized to nullptr. Copy the Stream setting information stored inside the SDK-internal after the success of RequestStreamSettingList() to this pointer.
CrInt32u*	numOfList An integer pointer that indicates the number of CrVideoStreamSetting returned by the list pointer. Developers should pass the address of a modifiable CrInt32u variable.

Return value

Type	Explanation
CrError	CrError_None on Success CrError_Api_NoApplicableInformation RequestStreamSettingList() may not have been executed. Please do RequestStreamSettingList().

Related API

• RequestStreamSettingList

• ReleaseStreamSettingList

• SetStreamSettingList

• IDeviceCallback::OnWarning

Special note (details)

This API can be executed only once. If you want to get the Stream setting information after this API, please request again to get the Stream setting information from the camera with RequestStreamSettingList().

ReleaseStreamSettingList

Overview

This function releases the CrVideoStreamSetting allocated by GetStreamSettingList().

Definition

CrError ReleaseStreamSettingList(CrDeviceHandle deviceHandle, CrVideoStreamSetting* list);

Input parameters

Type	Explanation
CrDeviceHandle	deviceHandle
CrVideoStreamSetting*	list CrVideoStreamSetting list pointer to release.

Output parameters

None

Return value

Type	Explanation
CrError	CrError_None If the list is released successfully CrError_Init if the SDK is uninitialized CrError_Generic_InvalidHandle If the deviceHandle is an invalid handle Other than errors above, see Status code & Error

Related API

• GetStreamSettingList

Special note (details)

None in particular

SetStreamSettingList

Overview

Request the SDK to update Stream setting information.

The function is asynchronous and returns to the user as soon as the SDK enqueues the requested action. The result of executing the update request to the camera should be confirmed by retrieving the Stream setting information with GetStreamSettingList().

Definition

CrError SetStreamSettingList(CrDeviceHandle deviceHandle, CrInt8u streamNum, CrVideoStreamSetting* setting);

Input parameters

Type	Explanation
CrDeviceHandle	deviceHandle
CrInt8u	streamNum The stream setting number.
CrVideoStreamSetting*	setting This parameter points to the CrVideoStreamSetting object which contains the Stream setting information that will be set to the device.

Output parameters

None

Return value

Type	Explanation
CrError	CrError_None on Success CrError_Init if the SDK is uninitialized CrError_Generic_InvalidHandle If the deviceHandle is an invalid handle Other than errors above, see Status code & Error

Related API

• IDeviceCallback::OnWarningExt

• GetStreamSettingList

Special note (details)

This API can be executed when CrDeviceProperty_StreamSettingListOperationStatus is Enable.

When [Access Authen.] is set to [Off] at the camera body, communication is performed without SSH connection authentication or encryption, so the content may be intercepted, or the camera may be accessed by an unintended third party.