AudioMixingOption

rn-agora-docs › "types" › AudioMixingOption

Description of AudioMixingOption interface

Hierarchy

  • AudioMixingOption

Index

Properties

Properties

cycle

• cycle: number

Defined in types.ts:387

Sets the number of playback loops:

  • Positive integer: Number of playback loops
  • -1: Infinite playback loops

filepath

• filepath: String

Defined in types.ts:372

Specifies the absolute path of the local or online audio file to be mixed. Supported audio formats: mp3, mp4, m4a, aac, 3gp, mkv and wav. See Supported Media Formats for details.

  • If the path begins with /assets/, the audio file is in the /assets/ directory.
  • Otherwise, the audio file is in the absolute path.

loopback

• loopback: boolean

Defined in types.ts:377

Sets which user can hear the audio mixing:

  • true: Only the local user can hear the audio mixing.
  • false: Both users can hear the audio mixing.

replace

• replace: boolean

Defined in types.ts:382

Sets the audio mixing content:

  • true: Only publish the specified audio file; the audio stream from the microphone is not published.
  • false: The local audio file is mixed with the audio stream from the microphone.
← AudioFrameOptionAudioRecordingOption →