1# native_audio_channel_layout.h 2 3## Overview 4 5The file declares the functions related to the speaker layout during recording and playback. 6 7**File to include**: <multimedia/native_audio_channel_layout.h> 8 9**Library**: none 10 11**System capability**: SystemCapability.Multimedia.Media.Core 12 13**Since**: 11 14 15**Related module**: [Core](capi-core.md) 16 17## Summary 18 19### Enums 20 21| Name| typedef Keyword| Description| 22| -- | -- | -- | 23| [OH_AudioChannelSet](#oh_audiochannelset) | OH_AudioChannelSet | Enumerates the audio channels.<br>Each channel is mapped to a variable of int64.| 24| [OH_AmbAttributeSet](#oh_ambattributeset) | OH_AmbAttributeSet | Enumerates the Hi-Fi stereo reverberation settings.<br>Int64 integers are used to indicate the Hi-Fi stereo reverberation attributes.| 25| [OH_AudioChannelLayout](#oh_audiochannellayout) | OH_AudioChannelLayout | Enumerates the layouts of audio channels.<br>Int64 integers are used to indicate the appearance and sequence of speakers during recording or playback.| 26 27## Enum Description 28 29### OH_AudioChannelSet 30 31``` 32enum OH_AudioChannelSet 33``` 34 35**Description** 36 37Enumerates the audio channels.<br>Each channel is mapped to a variable of int64. 38 39**System capability**: SystemCapability.Multimedia.Media.Core 40 41**Since**: 11 42 43| Value| Description| 44| -- | -- | 45| CH_SET_FRONT_LEFT = 1ULL << 0U | Front left channel.| 46| CH_SET_FRONT_RIGHT = 1ULL << 1U | Front right channel.| 47| CH_SET_FRONT_CENTER = 1ULL << 2U | Front center channel.| 48| CH_SET_LOW_FREQUENCY = 1ULL << 3U | Low-frequency channel.| 49| CH_SET_BACK_LEFT = 1ULL << 4U | Rear left channel.| 50| CH_SET_BACK_RIGHT = 1ULL << 5U | Rear right channel.| 51| CH_SET_FRONT_LEFT_OF_CENTER = 1ULL << 6U | Front left center channel.| 52| CH_SET_FRONT_RIGHT_OF_CENTER = 1ULL << 7U | Front right center channel.| 53| CH_SET_BACK_CENTER = 1ULL << 8U | Rear center channel.| 54| CH_SET_SIDE_LEFT = 1ULL << 9U | Left channel.| 55| CH_SET_SIDE_RIGHT = 1ULL << 10U | Right channel.| 56| CH_SET_TOP_CENTER = 1ULL << 11U | Top center channel.| 57| CH_SET_TOP_FRONT_LEFT = 1ULL << 12U | Top left front channel.| 58| CH_SET_TOP_FRONT_CENTER = 1ULL << 13U | Top center front channel.| 59| CH_SET_TOP_FRONT_RIGHT = 1ULL << 14U | Top right front channel.| 60| CH_SET_TOP_BACK_LEFT = 1ULL << 15U | Top left rear channel.| 61| CH_SET_TOP_BACK_CENTER = 1ULL << 16U | Top center rear channel.| 62| CH_SET_TOP_BACK_RIGHT = 1ULL << 17U | Top right rear channel.| 63| CH_SET_STEREO_LEFT = 1ULL << 29U | Stereo left channel.| 64| CH_SET_STEREO_RIGHT = 1ULL << 30U | Stereo right channel.| 65| CH_SET_WIDE_LEFT = 1ULL << 31U | Wide left channel.| 66| CH_SET_WIDE_RIGHT = 1ULL << 32U | Wide right channel.| 67| CH_SET_SURROUND_DIRECT_LEFT = 1ULL << 33U | Left surround channel.| 68| CH_SET_SURROUND_DIRECT_RIGHT = 1ULL << 34U | Right surround channel.| 69| CH_SET_LOW_FREQUENCY_2 = 1ULL << 35U | Low-frequency channel 2.| 70| CH_SET_TOP_SIDE_LEFT = 1ULL << 36U | Top left channel.| 71| CH_SET_TOP_SIDE_RIGHT = 1ULL << 37U | Top right channel.| 72| CH_SET_BOTTOM_FRONT_CENTER = 1ULL << 38U | Bottom center front channel.| 73| CH_SET_BOTTOM_FRONT_LEFT = 1ULL << 39U | Bottom left front channel.| 74| CH_SET_BOTTOM_FRONT_RIGHT = 1ULL << 40U | Bottom right front channel.| 75 76### OH_AmbAttributeSet 77 78``` 79enum OH_AmbAttributeSet 80``` 81 82**Description** 83 84Enumerates the Hi-Fi stereo reverberation settings.<br>Int64 integers are used to indicate the Hi-Fi stereo reverberation attributes. 85 86**System capability**: SystemCapability.Multimedia.Media.Core 87 88**Since**: 11 89 90| Value| Description| 91| -- | -- | 92| AMB_ORD_1 = 1ULL << 0U | First-order Hi-Fi stereo reverberation.| 93| AMB_ORD_2 = 2ULL << 0U | Second-order Hi-Fi stereo reverberation.| 94| AMB_ORD_3 = 3ULL << 0U | Third-order Hi-Fi stereo reverberation.| 95| AMB_COM_ACN = 0ULL << 8U | Hi-Fi stereo reverberation with ACN channel sorting.| 96| AMB_COM_FUMA = 1ULL << 8U | Hi-Fi stereo reverberation with FUMA channel sorting.| 97| AMB_NOR_N3D = 0ULL << 12U | N3D normalized Hi-Fi stereo reverberation.| 98| AMB_NOR_SN3D = 1ULL << 12U | SN3D normalized Hi-Fi stereo reverberation.| 99| AMB_MODE = 1ULL << 44U | Audio channel layout for Hi-Fi stereo reverberation.| 100 101### OH_AudioChannelLayout 102 103``` 104enum OH_AudioChannelLayout 105``` 106 107**Description** 108 109Enumerates the audio channel layouts.<br>Int64 integers are used to indicate the appearance and sequence of speakers during recording or playback. 110 111**System capability**: SystemCapability.Multimedia.Media.Core 112 113**Since**: 11 114 115| Value| Description| 116| -- | -- | 117| CH_LAYOUT_UNKNOWN = 0ULL | Unknown.| 118| CH_LAYOUT_MONO = CH_SET_FRONT_CENTER | Mono layout; 1 audio channel in total.| 119| CH_LAYOUT_STEREO = CH_SET_FRONT_LEFT \| CH_SET_FRONT_RIGHT | Stereo layout; 2 audio channels in total.| 120| CH_LAYOUT_STEREO_DOWNMIX = CH_SET_STEREO_LEFT \| CH_SET_STEREO_RIGHT | Stereo downmix layout; 2 audio channels in total.| 121| CH_LAYOUT_2POINT1 = CH_LAYOUT_STEREO \| CH_SET_LOW_FREQUENCY | 2.1 layout; 3 audio channels in total.| 122| CH_LAYOUT_3POINT0 = CH_LAYOUT_STEREO \| CH_SET_BACK_CENTER | 3.0 layout; 3 audio channels in total.| 123| CH_LAYOUT_SURROUND = CH_LAYOUT_STEREO \| CH_SET_FRONT_CENTER | Surround; 3 audio channels in total.| 124| CH_LAYOUT_3POINT1 = CH_LAYOUT_SURROUND \| CH_SET_LOW_FREQUENCY | 3.1 layout; 4 audio channels in total.| 125| CH_LAYOUT_4POINT0 = CH_LAYOUT_SURROUND \| CH_SET_BACK_CENTER | 4.0 layout; 4 audio channels in total.| 126| CH_LAYOUT_QUAD_SIDE = CH_LAYOUT_STEREO \| CH_SET_SIDE_LEFT \| CH_SET_SIDE_RIGHT | Quad side layout; 4 audio channels in total.| 127| CH_LAYOUT_QUAD = CH_LAYOUT_STEREO \| CH_SET_BACK_LEFT \| CH_SET_BACK_RIGHT | Quad layout; 4 audio channels in total.| 128| CH_LAYOUT_2POINT0POINT2 = CH_LAYOUT_STEREO \| CH_SET_TOP_SIDE_LEFT \| CH_SET_TOP_SIDE_RIGHT | 2.0.2 layout; 4 audio channels in total.| 129| CH_LAYOUT_AMB_ORDER1_ACN_N3D = AMB_MODE \| AMB_ORD_1 \| AMB_COM_ACN \| AMB_NOR_N3D | First-order FOA layout in ACN_N3D (ITU standards); 4 audio channels in total.| 130| CH_LAYOUT_AMB_ORDER1_ACN_SN3D = AMB_MODE \| AMB_ORD_1 \| AMB_COM_ACN \| AMB_NOR_SN3D | First-order FOA layout in ACN_SN3D (ITU standards); 4 audio channels in total.| 131| CH_LAYOUT_AMB_ORDER1_FUMA = AMB_MODE \| AMB_ORD_1 \| AMB_COM_FUMA | First-order FOA layout in FUMA (ITU standards); 4 audio channels in total.| 132| CH_LAYOUT_4POINT1 = CH_LAYOUT_4POINT0 \| CH_SET_LOW_FREQUENCY | 4.1 layout; 5 audio channels in total.| 133| CH_LAYOUT_5POINT0 = CH_LAYOUT_SURROUND \| CH_SET_SIDE_LEFT \| CH_SET_SIDE_RIGHT | 5.0 layout; 5 audio channels in total.| 134| CH_LAYOUT_5POINT0_BACK = CH_LAYOUT_SURROUND \| CH_SET_BACK_LEFT \| CH_SET_BACK_RIGHT | 5.0 rear layout; 5 audio channels in total.| 135| CH_LAYOUT_2POINT1POINT2 = CH_LAYOUT_2POINT0POINT2 \| CH_SET_LOW_FREQUENCY | 2.1.2 layout; 5 audio channels in total.| 136| CH_LAYOUT_3POINT0POINT2 = CH_LAYOUT_2POINT0POINT2 \| CH_SET_FRONT_CENTER | 3.0.2 layout; 5 audio channels in total.| 137| CH_LAYOUT_5POINT1 = CH_LAYOUT_5POINT0 \| CH_SET_LOW_FREQUENCY | 5.1 layout; 6 audio channels in total.| 138| CH_LAYOUT_5POINT1_BACK = CH_LAYOUT_5POINT0_BACK \| CH_SET_LOW_FREQUENCY | 5.1 rear layout; 6 audio channels in total.| 139| CH_LAYOUT_6POINT0 = CH_LAYOUT_5POINT0 \| CH_SET_BACK_CENTER | 6.0 layout; 6 audio channels in total.| 140| CH_LAYOUT_3POINT1POINT2 = CH_LAYOUT_3POINT1 \| CH_SET_TOP_FRONT_LEFT \| CH_SET_TOP_FRONT_RIGHT | 3.1.2 layout; 6 audio channels in total.| 141| CH_LAYOUT_6POINT0_FRONT = CH_LAYOUT_QUAD_SIDE \| CH_SET_FRONT_LEFT_OF_CENTER \| CH_SET_FRONT_RIGHT_OF_CENTER | 6.0 front layout; 6 audio channels in total.| 142| CH_LAYOUT_HEXAGONAL = CH_LAYOUT_5POINT0_BACK \| CH_SET_BACK_CENTER | Hexagonal layout; 6 audio channels in total.| 143| CH_LAYOUT_6POINT1 = CH_LAYOUT_5POINT1 \| CH_SET_BACK_CENTER | 6.1 layout; 7 audio channels in total.| 144| CH_LAYOUT_6POINT1_BACK = CH_LAYOUT_5POINT1_BACK \| CH_SET_BACK_CENTER | 6.1 rear layout; 7 audio channels in total.| 145| CH_LAYOUT_6POINT1_FRONT = CH_LAYOUT_6POINT0_FRONT \| CH_SET_LOW_FREQUENCY | 6.1 front layout; 7 audio channels in total.| 146| CH_LAYOUT_7POINT0 = CH_LAYOUT_5POINT0 \| CH_SET_BACK_LEFT \| CH_SET_BACK_RIGHT | 7.0 layout; 7 audio channels in total.| 147| CH_LAYOUT_7POINT0_FRONT = CH_LAYOUT_5POINT0 \| CH_SET_FRONT_LEFT_OF_CENTER \| CH_SET_FRONT_RIGHT_OF_CENTER | 7.0 front layout; 7 audio channels in total.| 148| CH_LAYOUT_7POINT1 = CH_LAYOUT_5POINT1 \| CH_SET_BACK_LEFT \| CH_SET_BACK_RIGHT | 7.1 layout; 8 audio channels in total.| 149| CH_LAYOUT_OCTAGONAL = CH_LAYOUT_5POINT0 \| CH_SET_BACK_LEFT \| CH_SET_BACK_CENTER \| CH_SET_BACK_RIGHT | Octagonal layout; 8 audio channels in total.| 150| CH_LAYOUT_5POINT1POINT2 = CH_LAYOUT_5POINT1 \| CH_SET_TOP_SIDE_LEFT \| CH_SET_TOP_SIDE_RIGHT | 5.1.2 layout; 8 audio channels in total.| 151| CH_LAYOUT_7POINT1_WIDE = CH_LAYOUT_5POINT1 \| CH_SET_FRONT_LEFT_OF_CENTER \| CH_SET_FRONT_RIGHT_OF_CENTER | 7.1 wide layout; 8 audio channels in total.| 152| CH_LAYOUT_7POINT1_WIDE_BACK = CH_LAYOUT_5POINT1_BACK \| CH_SET_FRONT_LEFT_OF_CENTER \| CH_SET_FRONT_RIGHT_OF_CENTER | 7.1 rear wide layout; 8 audio channels in total.| 153| CH_LAYOUT_AMB_ORDER2_ACN_N3D = AMB_MODE \| AMB_ORD_2 \| AMB_COM_ACN \| AMB_NOR_N3D | Second-order HOA layout in ACN_N3D (ITU standards); 9 audio channels in total.| 154| CH_LAYOUT_AMB_ORDER2_ACN_SN3D = AMB_MODE \| AMB_ORD_2 \| AMB_COM_ACN \| AMB_NOR_SN3D | Second-order HOA layout in ACN_SN3D (ITU standards); 9 audio channels in total.| 155| CH_LAYOUT_AMB_ORDER2_FUMA = AMB_MODE \| AMB_ORD_2 \| AMB_COM_FUMA | Second-order HOA layout in FUMA (ITU standards); 9 audio channels in total.| 156| CH_LAYOUT_5POINT1POINT4 = CH_LAYOUT_5POINT1 \| CH_SET_TOP_FRONT_LEFT \| CH_SET_TOP_FRONT_RIGHT \| CH_SET_TOP_BACK_LEFT \| CH_SET_TOP_BACK_RIGHT | 5.1.4 layout; 10 audio channels in total.| 157| CH_LAYOUT_7POINT1POINT2 = CH_LAYOUT_7POINT1 \| CH_SET_TOP_SIDE_LEFT \| CH_SET_TOP_SIDE_RIGHT | 7.1.2 layout; 10 audio channels in total.| 158| CH_LAYOUT_7POINT1POINT4 = CH_LAYOUT_7POINT1 \| CH_SET_TOP_FRONT_LEFT \| CH_SET_TOP_FRONT_RIGHT \| CH_SET_TOP_BACK_LEFT \| CH_SET_TOP_BACK_RIGHT | 7.1.4 layout; 12 audio channels in total.| 159| CH_LAYOUT_10POINT2 = CH_SET_FRONT_LEFT \| CH_SET_FRONT_RIGHT \| CH_SET_FRONT_CENTER \| CH_SET_TOP_FRONT_LEFT \| CH_SET_TOP_FRONT_RIGHT \| CH_SET_BACK_LEFT \| CH_SET_BACK_RIGHT \| CH_SET_BACK_CENTER \| CH_SET_SIDE_LEFT \| CH_SET_SIDE_RIGHT \| CH_SET_WIDE_LEFT \| CH_SET_WIDE_RIGHT | 10.2 layout; 12 audio channels in total.| 160| CH_LAYOUT_9POINT1POINT4 = CH_LAYOUT_7POINT1POINT4 \| CH_SET_WIDE_LEFT \| CH_SET_WIDE_RIGHT | 9.1.4 layout; 14 audio channels in total.| 161| CH_LAYOUT_9POINT1POINT6 = CH_LAYOUT_9POINT1POINT4 \| CH_SET_TOP_SIDE_LEFT \| CH_SET_TOP_SIDE_RIGHT | 9.1.6 layout; 16 audio channels in total.| 162| CH_LAYOUT_HEXADECAGONAL = CH_LAYOUT_OCTAGONAL \| CH_SET_WIDE_LEFT \| CH_SET_WIDE_RIGHT \| CH_SET_TOP_BACK_LEFT \| CH_SET_TOP_BACK_RIGHT \| CH_SET_TOP_BACK_CENTER \| CH_SET_TOP_FRONT_CENTER \| CH_SET_TOP_FRONT_LEFT \| CH_SET_TOP_FRONT_RIGHT | Hexadecagonal layout; 16 audio channels in total.| 163| CH_LAYOUT_AMB_ORDER3_ACN_N3D = AMB_MODE \| AMB_ORD_3 \| AMB_COM_ACN \| AMB_NOR_N3D | Third-order HOA layout in ACN_N3D (ITU standards); 16 audio channels in total.| 164| CH_LAYOUT_AMB_ORDER3_ACN_SN3D = AMB_MODE \| AMB_ORD_3 \| AMB_COM_ACN \| AMB_NOR_SN3D | Third-order HOA layout in ACN_SN3D (ITU standards); 16 audio channels in total.| 165| CH_LAYOUT_AMB_ORDER3_FUMA = AMB_MODE \| AMB_ORD_3 \| AMB_COM_FUMA | Third-order HOA layout in FUMA (ITU standards); 16 audio channels in total.| 166| CH_LAYOUT_22POINT2 = CH_LAYOUT_7POINT1POINT4 \| CH_SET_FRONT_LEFT_OF_CENTER \| CH_SET_FRONT_RIGHT_OF_CENTER \| CH_SET_BACK_CENTER \| CH_SET_TOP_CENTER \| CH_SET_TOP_FRONT_CENTER \| CH_SET_TOP_BACK_CENTER \| CH_SET_TOP_SIDE_LEFT \| CH_SET_TOP_SIDE_RIGHT \| CH_SET_BOTTOM_FRONT_LEFT \| CH_SET_BOTTOM_FRONT_RIGHT \| CH_SET_BOTTOM_FRONT_CENTER \| CH_SET_LOW_FREQUENCY_2 | 22.2 layout; 24 audio channels in total.| 167