AudioScene

Overview

Related Modules:

Audio

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

Variable Name

Description

CheckSceneCapability )(AudioHandle handle, const struct AudioSceneDescriptorscene, bool supported)

int32_t( 

Checks whether the configuration of an audio scene is supported.

SelectScene )(AudioHandle handle, const struct AudioSceneDescriptor scene)

int32_t(* 

Selects an audio scene.

Details

Field Documentation

CheckSceneCapability

  1. 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:

Name

Description

handleIndicates the audio handle.
sceneIndicates the pointer to the descriptor of the audio scene.
supportedIndicates the pointer to the variable specifying whether the configuration is supported. Value true means that the configuration is supported, and false means the opposite.

Returns:

Returns 0 if the result is obtained; returns a negative value otherwise.

See also:

SelectScene

SelectScene

  1. 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:

Name

Description

handleIndicates the audio handle.
sceneIndicates 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:

CheckSceneCapability