Custom audio effects renderer interface. More...

#import <NvsCustomAudioFx.h>

Inheritance diagram for <NvsCustomAudioFxRenderer>:

Instance Methods
(void)	- didInit
	Meishe SDK calls this method on custom audio effects to let the user initialize some resources. More...

(NvsAudioSampleFormat)	- didQuerySupportedInputAudioSampleFormat
	Meishe SDK calls this method on custom audio effects to let sdk to known audio format. More...

(void)	- didCleanup
	Meishe SDK calls this method on custom audio effects to let users clean up resources. More...

(NvsCustomAudioFxRenderError)	- didRender:outputSamples:
	Meishe SDK calls this method on custom audio effects to apply effect special effects on input audio samples. More...

(NvsCustomAudioFxRenderError)	- didFlushWithOutputSample:
	Meishe SDK calls this method on custom audio effects to apply effect special effects on input audio samples. Not implemented. More...

Detailed Description

Custom audio effects renderer interface.

Warning: In the NvsCustomAudioFxRenderer class, all public APIs are used in the UI thread! ! !

Method Documentation

◆ didCleanup

- (void) didCleanup

Meishe SDK calls this method on custom audio effects to let users clean up resources.

This method will only be called once at most in the life cycle of a custom audio effect, and will definitely be called after onInit. If onInit is not called, it will not be called.

◆ didFlushWithOutputSample:

- (NvsCustomAudioFxRenderError) didFlushWithOutputSample: (CMSampleBufferRef *) outputSamplesBuffer

Meishe SDK calls this method on custom audio effects to apply effect special effects on input audio samples. Not implemented.

◆ didInit

- (void) didInit

Meishe SDK calls this method on custom audio effects to let the user initialize some resources.

This method will only be called at most once during the life cycle of a custom audio effect. If the effect has never been used, this method will not be called.

◆ didQuerySupportedInputAudioSampleFormat

- (NvsAudioSampleFormat) didQuerySupportedInputAudioSampleFormat

Meishe SDK calls this method on custom audio effects to let sdk to known audio format.

This method will only be called at most once during the life cycle of a custom audio effect. If the effect has never been used, this method will not be called.

◆ didRender:outputSamples:

- (NvsCustomAudioFxRenderError) didRender:	(struct NvsCustomAudioFxRenderContext *)	renderContext
outputSamples:	(CMSampleBufferRef *)	outputSamplesBuffer

Meishe SDK calls this method on custom audio effects to apply effect special effects on input audio samples.

Parameters

renderContext Effects rendering context object

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

include/sdkcore/ios/NvsCustomAudioFx.h