PlayEffectOption
rn-agora-docs › "types" › PlayEffectOption
Hierarchy
- PlayEffectOption
Index
Properties
Properties
filepath
• filepath: String
Defined in types.ts:398
Absolute file path of the audio effect file.
gain
• gain: number
Defined in types.ts:420
Volume of the audio effect. The value ranges betwwen 0.0 and 100,0. The default value is 100.0. The lower the value, the lower the volume of the audio effect.
loopcount
• loopcount: number
Defined in types.ts:405
Sets the number of times the audio effect loops:
- 0: Plays the audio effect once.
- 1: Plays the audio effect twice.
- -1: Plays the audio effect in an indefinite loop until you call the stopEffect or stopAllEffects method.
pan
• pan: number
Defined in types.ts:416
Spatial position of the audio effect. The value ranges between -1.0 and 1.0.
- 0.0: The audio effect displays ahead.
- 1.0: The audio effect displays to the right.
- -1.0: The audio effect displays to the left.
pitch
• pitch: number
Defined in types.ts:409
Pitch of the audio effect. The value ranges between 0.5 and 2. The default value is 1 (no change to the pitch). The lower the value, the lower the pitch.
publish
• publish: boolean
Defined in types.ts:426
Set whether or not to publish the specified audio effect to the remote stream:
- true: The locally played audio effect is published to the Agora Cloud and the remote users can hear it.
- false: The locally played audio effect is not published to the Agora Cloud and the remote users cannot hear it.
soundId
• soundId: number
Defined in types.ts:394
ID of the specified audio effect. Each audio effect has a unique ID. If the audio effect is preloaded into the memory through the preloadEffect method, ensure that the soundID value is set to the same value as in the preloadEffect method.