AudioScene
Overview
Related Modules:
Description:
Provides scene-related APIs for audio rendering or capturing, including functions to select an audio scene and check whether the configuration of an audio scene is supported.
Since:
1.0
Version:
1.0
Summary
Data Fields
CheckSceneCapability )(AudioHandle handle, const struct AudioSceneDescriptor scene, bool supported) |
Checks whether the configuration of an audio scene is supported. |
SelectScene )(AudioHandle handle, const struct AudioSceneDescriptor scene) |
Details
Field Documentation
CheckSceneCapability
int32_t(* AudioScene::CheckSceneCapability) ([AudioHandle]($api-api-SmartVision-Devices-Audio.md#ga18675ddb073465fdeac33a897f675d79) handle, const struct [AudioSceneDescriptor]($api-api-SmartVision-Devices-AudioSceneDescriptor.md) *scene, bool *supported)
Description:
Checks whether the configuration of an audio scene is supported.
Parameters:
Returns:
Returns 0 if the result is obtained; returns a negative value otherwise.
See also:
SelectScene
int32_t(* AudioScene::SelectScene) ([AudioHandle]($api-api-SmartVision-Devices-Audio.md#ga18675ddb073465fdeac33a897f675d79) handle, const struct [AudioSceneDescriptor]($api-api-SmartVision-Devices-AudioSceneDescriptor.md) *scene)
Description:
Selects an audio scene.
Parameters:
handle | Indicates the audio handle. |
scene | Indicates the pointer to the descriptor of the audio scene to select. |
Returns:
Returns 0 if the scene is selected successfully; returns a negative value otherwise.
See also: