NvsWaveformDataGenerator Class Reference

Audio waveform data generator. More...

#import <NvsWaveformDataGenerator.h>

Inheritance diagram for NvsWaveformDataGenerator:

Instance Methods
(instancetype)	- init
	Initialization. More...
(int64_t)	- getAudioFileDuration:
	Get the audio file duration. More...
(int64_t)	- getAudioFileSampleCount:
	Get the audio file sample count. More...
(void)	- cancelTask:
	cancel task More...
(int64_t)	- generateWaveformData:samplesPerGroup:startGroupIndex:groupCount:flags:
	Get the audio waveform data. More...
(void)	- notifyWaveformDataReady:samplesPerGroup:leftWaveformData:rightWaveformData:
(void)	- notifyWaveformDataFailed:samplesPerGroup:

Properties
id< NvsWaveformDataGeneratorDelegate >	delegate

Detailed Description

Audio waveform data generator.

Audio waveform data generation class

Warning

In the NvsWaveformDataGenerator class, all public APIs are used in the UI thread! ! !

Since

2.21.0

Method Documentation

cancelTask:

- (void) cancelTask:

(int64_t)

taskId

cancel task

Parameters

taskId

task id

Since

2.21.0

generateWaveformData:samplesPerGroup:startGroupIndex:groupCount:flags:

- (int64_t) generateWaveformData:		(NSString *)	audioFilePath
samplesPerGroup:		(int64_t)	samplesPerGroup
startGroupIndex:		(int64_t)	startGroupIndex
groupCount:		(int64_t)	groupCount
flags:		(int)	flags

Get the audio waveform data.

Parameters

audioFilePath	audio file path
samplesPerGroup	number of samples per group
startGroupIndex	start group index
groupCount	group count.When 0 is passed in and startgroupindex is also 0, all audio file data will be obtained
flags	flag field. If there is no special requirement, please fill in

Returns

Return the task id

Since

2.21.0

getAudioFileDuration:

- (int64_t) getAudioFileDuration:

(NSString *)

audioFilePath

Get the audio file duration.

Parameters

audioFilePath

audio file path

Returns

Return the audio file duration

Since

2.21.0

getAudioFileSampleCount:

- (int64_t) getAudioFileSampleCount:

(NSString *)

audioFilePath

Get the audio file sample count.

Parameters

audioFilePath

audio file path

Returns

Return the audio file sample count

Since

2.21.0

init

- (instancetype) init

Initialization.

Returns

Returns the NvsWaveformDataGenerator object.

Since

2.21.0

notifyWaveformDataFailed:samplesPerGroup:

- (void) notifyWaveformDataFailed:		(int64_t)	waveformTaskId
samplesPerGroup:		(int64_t)	samplesPerGroup

notifyWaveformDataReady:samplesPerGroup:leftWaveformData:rightWaveformData:

- (void) notifyWaveformDataReady:		(int64_t)	waveformTaskId
samplesPerGroup:		(int64_t)	samplesPerGroup
leftWaveformData:		(NSData *)	leftWaveformData
rightWaveformData:		(NSData *)	rightWaveformData

Property Documentation

delegate

- (id<NvsWaveformDataGeneratorDelegate>) delegate

readwritenonatomicweak

---

The documentation for this class was generated from the following file:

• include/sdkcore/ios/NvsWaveformDataGenerator.h