AudioControl
- Overview
- Summary
- Data Fields
- Details
- Field Documentation
- Flush
- Pause
- Resume
- Start
- Stop

AudioControl

Overview

Related Modules:

Description:

Provides control-related APIs for audio rendering or capturing, including functions to start, stop, pause, and resume audio rendering or capturing, and flush data in the audio buffer.

Since:

1.0

Version:

1.0

Summary

Data Fields

Variable Name	Description
Start )(AudioHandle handle)	int32_t( Starts audio rendering or capturing.
Stop )(AudioHandle handle)	int32_t( Stops audio rendering or capturing.
Pause )(AudioHandle handle)	int32_t( Pauses audio rendering or capturing.
Resume )(AudioHandle handle)	int32_t( Resumes audio rendering or capturing.
Flush )(AudioHandle handle)	int32_t(* Flushes data in the audio buffer.

Details

Field Documentation

Flush


1. int32_t(* AudioControl::Flush) ([AudioHandle]($api-api-SmartVision-Devices-Audio.md#ga18675ddb073465fdeac33a897f675d79) handle)

Description:

Flushes data in the audio buffer.

Parameters:

Name	Description
handle	Indicates the audio handle.

Returns:

Returns 0 if the flush is successful; returns a negative value otherwise.

Pause


1. int32_t(* AudioControl::Pause) ([AudioHandle]($api-api-SmartVision-Devices-Audio.md#ga18675ddb073465fdeac33a897f675d79) handle)

Description:

Pauses audio rendering or capturing.

Parameters:

Name	Description
handle	Indicates the audio handle.

Returns:

Returns 0 if the rendering or capturing is successfully paused; returns a negative value otherwise.

See also:

Resume


1. int32_t(* AudioControl::Resume) ([AudioHandle]($api-api-SmartVision-Devices-Audio.md#ga18675ddb073465fdeac33a897f675d79) handle)

Description:

Resumes audio rendering or capturing.

Parameters:

Name	Description
handle	Indicates the audio handle.

Returns:

Returns 0 if the rendering or capturing is successfully resumed; returns a negative value otherwise.

See also:

Pause

Start


1. int32_t(* AudioControl::Start) ([AudioHandle]($api-api-SmartVision-Devices-Audio.md#ga18675ddb073465fdeac33a897f675d79) handle)

Description:

Starts audio rendering or capturing.

Parameters:

Name	Description
handle	Indicates the audio handle.

Returns:

Returns 0 if the rendering or capturing is successfully started; returns a negative value otherwise.

See also:

Stop


1. int32_t(* AudioControl::Stop) ([AudioHandle]($api-api-SmartVision-Devices-Audio.md#ga18675ddb073465fdeac33a897f675d79) handle)

Description:

Stops audio rendering or capturing.

Parameters:

Name	Description
handle	Indicates the audio handle.

Returns:

Returns 0 if the rendering or capturing is successfully stopped; returns a negative value otherwise.

See also:

Start