Agora RTC Objective-C API Reference
Refactor
|
Inherits <NSObject>.
Instance Methods | |
(BOOL) | - adaptAudioFrame:dstFrame: |
(void) | - setEnabled: |
(BOOL) | - isEnabled |
(NSInteger) | - setPropertyWithKey:value: |
(NSInteger) | - getPropertyWithKey:value: |
(NSString *__nonnull) | - getName |
The AgoraAudioFilterDelegate
protocol.
This protocol is the intermediate node for audio, which reads audio frames from the underlying pipeline and writes audio frames back after adaptation.
- (BOOL) adaptAudioFrame: | (AgoraAudioPcmFrame *__nonnull) | srcFrame | |
dstFrame: | (AgoraAudioPcmFrame *_Nullable *_Nullable) | dstFrame | |
Adapts the audio frame.
srcFrame | The pointer to the audio frame that you want to adapt. |
dstFrame | The in/out pointer to the adapted audio frame. |
YES
: Success.NO
: Failure. For example, the IAudiofilter object drops the audio frame. - (void) setEnabled: | (BOOL) | enabled |
Enables or disables the audio filter.
enable | Whether to enable the audio filter:
|
- (BOOL) isEnabled |
Checks whether the audio filter is enabled.
YES
: The audio filter is enabled.NO
: The audio filter is not enabled. - (NSInteger) setPropertyWithKey: | (NSString *__nonnull) | key | |
value: | (NSData *__nonnull) | value | |
Sets a private property in the IAudioFilter
class.
key | The pointer to the property name. |
value | The pointer to the buffer of this private property. |
- (NSInteger) getPropertyWithKey: | (NSString *__nonnull) | key | |
value: | (NSData *_Nullable *_Nullable) | value | |
Gets a private property in the IAudioFilter
class.
key | The pointer to the property name. |
(in/out) | value The pointer to the buffer of this private property. |
- (NSString * __nonnull) getName |
Gets the name of the AgoraAudioFilterDelegate
class.