Release 12.0.0.18314
[platform/core/csapi/tizenfx.git] / src / Tizen.AIAvatar / src / public / Avatar / AudioOptions.cs
1 /*
2  * Copyright(c) 2023 Samsung Electronics Co., Ltd.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17
18 using System.ComponentModel;
19 using Tizen.Multimedia;
20
21 namespace Tizen.AIAvatar
22 {
23     /// <summary>
24     /// Provides the ability to audio 
25     /// </summary>
26     // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
27     [EditorBrowsable(EditorBrowsableState.Never)]
28     public class AudioOptions
29     {
30         private int sampleRate;
31         private AudioChannel channel;
32         private AudioSampleType sampleType;
33
34         /// <summary>
35         /// Initializes a new instance of the AudioOptions class with the specified sample rate, channel, and sampleType.
36         /// </summary>
37         /// <param name="sampleRate">the audio sample rate (8000 ~ 192000Hz)</param>
38         /// <param name="channel">the audio channel type.</param>
39         /// <param name="sampleType">the audio sample type.</param>
40         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
41         [EditorBrowsable(EditorBrowsableState.Never)]
42         public AudioOptions(int sampleRate, AudioChannel channel, AudioSampleType sampleType)
43         {
44             this.sampleRate = sampleRate;
45             this.channel = channel;
46             this.sampleType = sampleType;
47         }
48
49         /// <summary>
50         /// The audio sample rate (8000 ~ 192000Hz)
51         /// </summary>
52         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
53         [EditorBrowsable(EditorBrowsableState.Never)]
54         public int SampleRate { get => sampleRate; set => sampleRate = value; }
55
56         /// <summary>
57         /// The audio channel type
58         /// </summary>
59         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
60         [EditorBrowsable(EditorBrowsableState.Never)]
61         public AudioChannel Channel { get => channel; set => channel = value; }
62
63         /// <summary>
64         /// The audio sample type
65         /// </summary>
66         // This will be public opened after ACR done. (Before ACR, need to be hidden as Inhouse API)
67         [EditorBrowsable(EditorBrowsableState.Never)]
68         public AudioSampleType SampleType { get => sampleType; set => sampleType = value; }
69     }
70 }