AudioCapture

Overview

Related Modules:

Audio

Description:

Provides capabilities for audio capturing, including controlling the capturing, setting audio attributes, scenes, and volume, and capturing audio frames.

Since:

1.0

Version:

1.0

Summary

Data Fields

Variable Name

Description

control

struct AudioControl 

Defines the audio control. For details, see AudioControl.

attr

struct AudioAttribute 

Defines the audio attribute. For details, see AudioAttribute.

scene

struct AudioScene 

Defines the audio scene. For details, see AudioScene.

volume

struct AudioVolume 

Defines audio volume. For details, see AudioVolume.

CaptureFrame )(struct AudioCapture capture, void frame, uint64_t requestBytes, uint64_t replyBytes)

int32_t( 

Reads a frame of input data (uplink data) from the audio driver for capturing.

GetCapturePosition )(struct AudioCapture capture, uint64_t frames, struct AudioTimeStamp time)

int32_t( 

Obtains the last number of input audio frames.

Details

Field Documentation

CaptureFrame

  1. int32_t(* AudioCapture::CaptureFrame) (struct [AudioCapture]($api-api-SmartVision-Devices-AudioCapture.md) *capture, void *frame, uint64_t requestBytes, uint64_t *replyBytes)

Description:

Reads a frame of input data (uplink data) from the audio driver for capturing.

Parameters:

Name

Description
capture Indicates the pointer to the AudioCapture object to operate.
frame Indicates the pointer to the input data to read.
requestBytes Indicates the size of the input data, in bytes.
replyBytes Indicates the pointer to the actual length (in bytes) of the audio data to read.

Returns:

Returns 0 if the input data is read successfully; returns a negative value otherwise.

GetCapturePosition

  1. int32_t(* AudioCapture::GetCapturePosition) (struct [AudioCapture]($api-api-SmartVision-Devices-AudioCapture.md) *capture, uint64_t *frames, struct [AudioTimeStamp]($api-api-SmartVision-Devices-AudioTimeStamp.md) *[time]($api-api-SmartVision-Devices-zh-cn_topic_0000001054879478.md#gae7841e681c8c9d59818568d39553642c))

Description:

Obtains the last number of input audio frames.

Parameters:

Name

Description
capture Indicates the pointer to the AudioCapture object to operate.
frames Indicates the pointer to the last number of input audio frames.
time Indicates the pointer to the timestamp associated with the frame.

Returns:

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

See also:

CaptureFrame