Documentation
Interactive Live Streaming Premium
Agora.io Community
English
search-icon
Set the Audio Profile
Last updated 2021/07/22 07:34:13

Introduction

High-fidelity audio is essential for professional audio scenarios, such as for podcasts and singing competitions. For example, podcasts require stereo and high-fidelity audio. High-fidelity audio refers to an audio profile with a sample rate of 48 kHz and a bitrate of 128 Kbps.

To obtain high-fidelity audio during real-time communications, you can choose the appropriate audio profile based on the audio quality, channel, and scenario.

Implementation

Before setting the audio profile, ensure that you have implemented the basic real-time communication functions in your project. See the Quickstart Guides for details:

The Agora SDK provides the setAudioProfile method to set the appropriate audio profile according to the scenario.

API call sequence

The following diagram shows how to set the audio profile:

Parameters and applications

You can set the profile and scenario parameters based on the requirements of different applications, such as the audio quality and the audio player.

Parameters Applications Options
profile High-fidelity audio
  • MusicHighQuality
  • MusicHighQualityStereo
    		•
    Standard audio
  • MusicStandard
  • MusicStandardStereo
    		•
    No requirement for audio quality
  • Default
  • SpeechStandard
    		•
    scenario Prioritize the audio quality and effects GameStreaming
    Frequently mute/unmute the microphone ChatRoomEntertainment
    External audio player ShowRoom
    Gaming noise reduction ChatRoomGaming
    Smoothness and stability Education
    Use IoT devices with low power consumption Iot
    Meeting scenario that mainly contains the human voice Meeting
    Stable transmission quality Default

    You can also set the profile and scenario parameters based on different applications.

    Applications profile scenario Features
    One-to-one classroom Default Default Prioritizes the call quality with smooth transmission and high-fidelity audio.
    Battle royale game SpeechStandard ChatRoomGaming Noise reduction and transmits the voice only. Reduces the transmission rate and suitable for multiplayer games.
    Murder mystery game MusicStandard ChatRoomEntertainment High-fidelity audio encoding and decoding. No volume or audio quality change when you mute/unmute the microphone.
    KTV MusicHighQuality GameStreaming High-fidelity audio and effects. Adapts to the high-fidelity audio application.
    Podcast MusicHighQualityStereo ShowRoom High-fidelity audio and stereo panning. Support for professional audio hardware.
    Music education MusicStandardStereo GameStreaming Prioritizes audio quality. Suitable for transmitting live external audio effects.
    Collaborative teaching MusicStandardStereo ChatRoomEntertainment High-fidelity audio and effects. No volume or audio quality change when you mute/unmute the microphone.

    Sample code

    // swift
// Gaming
agoraKit.setAudioProfile(.speechStandard, scenario: .chatRoomGaming)
// Entertainment
agoraKit.setAudioProfile(.musicStandard, scenario: .chatRoomEntertainment)
// KTV
agoraKit.setAudioProfile(.musicHighQuality, scenario: .chatRoomEntertainment)
// FM high-fidelity
agoraKit.setAudioProfile(.musicHighQuality, scenario: .gameStreaming)
    // objective-c
// Gaming
[agoraKit setAudioProfile: AgoraAudioProfileSpeechStandard scenario: AgoraAudioScenarioChatRoomGaming];
// Entertainment
[agoraKit setAudioProfile: AgoraAudioProfilemusicStandard, scenario: AgoraAudioScenarioChatRoomEntertainment];
// KTV
[agoraKit setAudioProfile: AgoraAudioProfileMusicHighQuality, scenario: AgoraAudioScenarioChatRoomEntertainment];
// FM high-fidelity
[agoraKit setAudioProfile: AgoraAudioProfilemusicHighQuality, scenario: AgoraAudioScenarioGameStreaming]

    API reference

    Considerations

    Call this method before calling the joinChannelByToken method.

    When you set the volume of a device, you can set either the in-call volume or the media volume.

    • You can set the in-call volume during an audio or video call.
    • You can set the media volume when you play video, games, or background music.

    The differences between the two types of volumes are as follows:

    • The in-call volume cannot be set as 0.
    • The media volume can be set as 0.

    The audio scenarios in the setAudioProfile method use different volume settings.

    Audio scenario Volume setting
    GameStreaming All users use the media volume.
    Default
  • In the Communication profile, all users use the in-call volume.
  • In the Live-broadcast profile, the hosts use the in-call volume, while the audience use the media volume.
    		•
    Education
    ShowRoom
    ChatRoomEntertainment All users use the in-call volume.
    ChatRoomGaming All users use the in-call volume.
    Iot All users use the in-call volume.
    Meeting All users use the media volume.

    Given the system restrictions, the media volume can be set as 0, but not the in-call volume. Therefore, if you want to adjust the volume to 0, ensure that you set an audio scenario that uses the media volume.

    Reference

    When setting the audio profile, you can also refer to the following articles: