RhythmPlayerConfig | react-native-agora

The metronome configuration, which is set in startRhythmPlayer or configRhythmPlayer.

Index

new RhythmPlayerConfig(params?: undefined | { beatsPerMeasure?: undefined | number; beatsPerMinute?: undefined | number; publish?: undefined | false | true }): RhythmPlayerConfig

Parameters
- Optional params: undefined | { beatsPerMeasure?: undefined | number; beatsPerMinute?: undefined | number; publish?: undefined | false | true }
Returns RhythmPlayerConfig

beatsPerMeasure: undefined | number

The number of beats per measure. The range is 1 to 9. The default value is 4, which means that each measure contains one downbeat and three upbeats.

beatsPerMinute: undefined | number

Tempo (beats per minute). The range is 60 to 360. The default value is 60, which means that the metronome plays 60 beats in one minute.

publish: undefined | false | true

Whether to publish the sound of the metronome to remote users:

true: (Default) Publish. Both the local user and remote users can hear the metronome.
false: Do not publish. Only the local user can hear the metronome.