ZegoAudioEffectPlayer Class Reference
Inherits from | NSObject |
---|---|
Declared in | ZegoExpressDefines.h |
– setEventHandler:
event handler for audio effect player.
- (void)setEventHandler:(nullable id<ZegoAudioEffectPlayerEventHandler>)handler
Parameters
handler |
event handler for audio effect player. |
---|
Declared In
ZegoExpressDefines.h
– start:path:config:
Description: ID for the audio effect. The SDK uses audioEffectID to control the playback of sound effects. The SDK does not force the user to pass in this parameter as a fixed value. It is best to ensure that each sound effect can have a unique ID. The recommended methods are static self-incrementing ID or the hash of the incoming sound effect file path.
- (void)start:(unsigned int)audioEffectID path:(nullable NSString *)path config:(nullable ZegoAudioEffectPlayConfig *)config
Parameters
audioEffectID |
Description: ID for the audio effect. The SDK uses audioEffectID to control the playback of sound effects. The SDK does not force the user to pass in this parameter as a fixed value. It is best to ensure that each sound effect can have a unique ID. The recommended methods are static self-incrementing ID or the hash of the incoming sound effect file path. |
---|---|
path |
The absolute path of the local resource. |
config |
Audio effect playback configuration. |
Declared In
ZegoExpressDefines.h
– stop:
ID for the audio effect.
- (void)stop:(unsigned int)audioEffectID
Parameters
audioEffectID |
ID for the audio effect. |
---|
Declared In
ZegoExpressDefines.h
– pause:
ID for the audio effect.
- (void)pause:(unsigned int)audioEffectID
Parameters
audioEffectID |
ID for the audio effect. |
---|
Declared In
ZegoExpressDefines.h
– resume:
ID for the audio effect.
- (void)resume:(unsigned int)audioEffectID
Parameters
audioEffectID |
ID for the audio effect. |
---|
Declared In
ZegoExpressDefines.h
– stopAll
Available since: 1.16.0 Description: Stop playing all audio effect. When to call: Some audio effects are Playing. Restrictions: None.
- (void)stopAll
Declared In
ZegoExpressDefines.h
– pauseAll
Available since: 1.16.0 Description: Pause playing all audio effect. When to call: It can be called after [createAudioEffectPlayer]. Restrictions: None.
- (void)pauseAll
Declared In
ZegoExpressDefines.h
– resumeAll
Available since: 1.16.0 Description: Resume playing all audio effect. When to call: It can be called after [pauseAll]. Restrictions: None.
- (void)resumeAll
Declared In
ZegoExpressDefines.h
– seekTo:audioEffectID:callback:
Point in time of specified playback progress.
- (void)seekTo:(unsigned long long)millisecond audioEffectID:(unsigned int)audioEffectID callback:(nullable ZegoAudioEffectPlayerSeekToCallback)callback
Parameters
millisecond |
Point in time of specified playback progress. |
---|---|
audioEffectID |
ID for the audio effect. |
callback |
The result of seek. |
Declared In
ZegoExpressDefines.h
– setVolume:audioEffectID:
Volume.
Value range: The range is 0 ~ 200.
Default value: The default is 100.
- (void)setVolume:(int)volume audioEffectID:(unsigned int)audioEffectID
Parameters
volume |
Volume. |
---|---|
audioEffectID |
ID for the audio effect. |
Declared In
ZegoExpressDefines.h
– setPlayVolume:audioEffectID:
Volume.
Value range: The range is 0 ~ 200.
Default value: The default is 100.
- (void)setPlayVolume:(int)volume audioEffectID:(unsigned int)audioEffectID
Parameters
volume |
Volume. |
---|---|
audioEffectID |
ID for the audio effect. |
Declared In
ZegoExpressDefines.h
– setPublishVolume:audioEffectID:
Volume.
Value range: The range is 0 ~ 200.
Default value: The default is 100.
- (void)setPublishVolume:(int)volume audioEffectID:(unsigned int)audioEffectID
Parameters
volume |
Volume. |
---|---|
audioEffectID |
ID for the audio effect. |
Declared In
ZegoExpressDefines.h
– setVolumeAll:
Volume.
Value range: The range is 0 ~ 200.
Default value: The default is 100.
- (void)setVolumeAll:(int)volume
Parameters
volume |
Volume. |
---|
Declared In
ZegoExpressDefines.h
– setPlayVolumeAll:
Volume.
Value range: The range is 0 ~ 200.
Default value: The default is 100.
- (void)setPlayVolumeAll:(int)volume
Parameters
volume |
Volume. |
---|
Declared In
ZegoExpressDefines.h
– setPublishVolumeAll:
Volume.
Value range: The range is 0 ~ 200.
Default value: The default is 100.
- (void)setPublishVolumeAll:(int)volume
Parameters
volume |
Volume. |
---|
Declared In
ZegoExpressDefines.h
– setPlaySpeed:audioEffectID:
The speed of play.
Value range: The range is 0.5 ~ 2.0.
Default value: The default is 1.0.
- (void)setPlaySpeed:(float)speed audioEffectID:(unsigned int)audioEffectID
Parameters
speed |
The speed of play. |
---|---|
audioEffectID |
ID for the audio effect. |
Declared In
ZegoExpressDefines.h
– getTotalDuration:
ID for the audio effect.
- (unsigned long long)getTotalDuration:(unsigned int)audioEffectID
Parameters
audioEffectID |
ID for the audio effect. |
---|
Return Value
Unit is millisecond.
Declared In
ZegoExpressDefines.h
– getCurrentProgress:
ID for the audio effect.
- (unsigned long long)getCurrentProgress:(unsigned int)audioEffectID
Parameters
audioEffectID |
ID for the audio effect. |
---|
Declared In
ZegoExpressDefines.h
– loadResource:audioEffectID:callback:
the absolute path of the audio effect resource and cannot be nil or “”.
Value range: “assets://"、"ipod-library://” and network url are not supported.
- (void)loadResource:(NSString *)path audioEffectID:(unsigned int)audioEffectID callback:(nullable ZegoAudioEffectPlayerLoadResourceCallback)callback
Parameters
path |
the absolute path of the audio effect resource and cannot be nil or “”. |
---|---|
audioEffectID |
ID for the audio effect. |
callback |
load audio effect resource result. |
Declared In
ZegoExpressDefines.h
– unloadResource:
ID for the audio effect loaded.
- (void)unloadResource:(unsigned int)audioEffectID
Parameters
audioEffectID |
ID for the audio effect loaded. |
---|
Declared In
ZegoExpressDefines.h
– updatePosition:position:
ID for the audio effect.
- (void)updatePosition:(unsigned int)audioEffectID position:(const float [ _Nonnull 3 ])position
Parameters
audioEffectID |
ID for the audio effect. |
---|---|
position |
The unit vector of the front axis of its own coordinate system. The parameter is a float array with a length of 3. |
Declared In
ZegoExpressDefines.h
– getIndex
Audio effect player index.
- (NSNumber *)getIndex
Return Value
Audio effect player index.
Declared In
ZegoExpressDefines.h
+ new
Please use the [createAudioEffectPlayer] function in ZegoExpressEngine class instead.
+ (instancetype)new
Declared In
ZegoExpressDefines.h
– init
Please use the [createAudioEffectPlayer] function in ZegoExpressEngine class instead.
- (instancetype)init
Declared In
ZegoExpressDefines.h