diff --git a/src/Tizen.Multimedia/AudioManager/AudioDevice.cs b/src/Tizen.Multimedia/AudioManager/AudioDevice.cs index 2f8103e7570..81a80382094 100755 --- a/src/Tizen.Multimedia/AudioManager/AudioDevice.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioDevice.cs @@ -23,7 +23,11 @@ namespace Tizen.Multimedia { /// - /// Provides the ability to query the information of sound devices. + /// Represents an audio device in the system, providing functionality to query and manipulate its properties. + /// The class allows developers to interact with audio devices by retrieving + /// detailed information such as the device's ID, name, type, I/O direction, and its current running state. + /// Furthermore, it provides methods for getting and setting sample formats and rates, managing resampling options, + /// and restricting stream types to media-only, facilitating optimized audio handling for diverse applications. /// /// 3 public class AudioDevice @@ -51,35 +55,47 @@ internal AudioDevice(IntPtr deviceHandle) } /// - /// Gets the ID of the device. + /// Gets the unique identifier of the audio device. + /// This ID serves as a reference to identify the device within the system and + /// is crucial for performing operations on specific devices. /// /// The id of the device. /// 3 public int Id => _id; /// - /// Gets the name of the device. + /// Gets the name of the audio device. + /// This property provides a human-readable identifier for the device, + /// which can be used in user interfaces or logs to display information + /// about the current audio output/input device. /// /// The name of the device. /// 3 public string Name { get; } /// - /// Gets the type of the device. + /// Gets the type of the audio device. + /// This property returns an enumerated value of type + /// that indicates the specific category of the device, such as speakers, microphones, + /// or headphones, which helps in distinguishing between different device functionalities. /// /// The of the device. /// 3 public AudioDeviceType Type => _type; /// - /// Gets the IO direction of the device. + /// Gets the input/output (I/O) direction of the audio device. + /// This property indicates whether the device is designed for input (recording) or output (playback), + /// allowing developers to manage device usage appropriately in their applications. /// /// The IO direction of the device. /// 3 public AudioDeviceIoDirection IoDirection => _ioDirection; /// - /// Gets the running state of the device. + /// Gets a value indicating whether the audio device is currently running. + /// This property checks the operational state of the device and returns true + /// if the device is active and processing audio, or false if it is idle or inactive. /// /// true if the audio stream of device is running actually; otherwise, false. /// 5 @@ -95,7 +111,10 @@ public bool IsRunning } /// - /// Gets the device's supported sample formats. + /// Retrieves a collection of audio sample formats supported by the device. + /// This method returns an enumerable list of values + /// indicating the different audio formats the device can handle, enabling applications + /// to select a compatible format for audio processing. /// /// An IEnumerable<AudioSampleFormat> that contains supported sample formats. /// @@ -127,7 +146,9 @@ IEnumerable RetrieveFormats() } /// - /// Sets the device's sample format. + /// Sets the sample format for the audio device. + /// This method allows developers to specify a desired for + /// audio playback or recording. /// /// The to set to the device. /// @@ -142,7 +163,9 @@ public void SetSampleFormat(AudioSampleFormat format) } /// - /// Gets the device's sample format. + /// Gets the current sample format used by the audio device. + /// This method retrieves the current the device is operating with, + /// allowing applications to verify or adjust to the active format being utilized for audio streams. /// /// The of the device. /// @@ -195,7 +218,9 @@ private uint ConvertRateToCoreValue(uint rate) } /// - /// Gets the device's supported sample rates. + /// Retrieves the sample rates that the audio device supports. + /// This method returns an enumerable list of supported sample rates, allowing developers + /// to select an appropriate rate for audio processing based on the capabilities of the device. /// /// An IEnumerable<uint> that contains supported sample rates. /// @@ -229,7 +254,10 @@ IEnumerable RetrieveRates() } /// - /// Sets the device's sample rate. + /// Sets the sample rate for the audio device. + /// This method allows you to specify a desired sample rate (in Hz) for audio playback or recording. + /// Choosing an appropriate sample rate is important for maintaining audio quality and ensuring compatibility + /// with audio data formats. /// /// The sample rate to set to the device. /// @@ -244,7 +272,9 @@ public void SetSampleRate(uint rate) } /// - /// Gets the device's sample rate. + /// Gets the current sample rate of the audio device. + /// This method retrieves the sample rate currently in use for audio processing, allowing + /// applications to ensure they are operating with the correct audio quality settings. /// /// The sample rate of the device. /// @@ -261,7 +291,10 @@ public uint GetSampleRate() } /// - /// Sets the device's 'avoid resampling' property. + /// Sets the 'avoid resampling' property for the audio device. + /// This property controls whether the device should avoid resampling audio data during playback. + /// Enabling this feature can help preserve audio quality by preventing alterations to audio that + /// may happen during playback. /// /// The 'avoid resampling' value to set to the device. /// @@ -279,7 +312,9 @@ public void SetAvoidResampling(bool enable) } /// - /// Gets the device's 'avoid resampling' property. + /// Gets the current state of the 'avoid resampling' property for the audio device. + /// This method returns whether the device is currently configured to avoid resampling audio data, + /// allowing developers to assess the current settings related to audio processing quality. /// /// The 'avoid resampling' property of the device. /// @@ -298,7 +333,10 @@ public bool GetAvoidResampling() } /// - /// Sets the restriction of stream type only for media. + /// Sets a restriction on the audio device to allow only media streams. + /// This method configures the device to accept only audio streams of type + /// . When enabled, the device will reject + /// any other stream types, ensuring that it is exclusively used for media playback. /// /// The 'media stream only' value to set to the device. /// @@ -315,7 +353,9 @@ public void SetMediaStreamOnly(bool enable) } /// - /// Gets the restriction of stream type only for media. + /// Retrieves the current restriction status of the audio device regarding media streams. + /// This method checks whether the device is currently configured to accept only media streams, + /// returning a boolean value that indicates the state of the restriction. /// /// The 'media stream only' property of the device. /// @@ -334,7 +374,11 @@ public bool GetMediaStreamOnly() } /// - /// Returns a string that represents the current object. + /// Returns a string representation of the current instance. + /// This method provides a formatted string that includes key properties of the audio device, + /// such as its unique identifier, name, type, I/O direction, and running state. + /// This representation can be useful for logging, debugging, or displaying device information + /// in user interfaces. /// /// A string that represents the current object. /// 4 @@ -342,7 +386,9 @@ public override string ToString() => $"Id={Id}, Name={Name}, Type={Type}, IoDirection={IoDirection}, IsRunning={IsRunning}"; /// - /// Compares an object to an instance of for equality. + /// Compares the current instance of with another object for equality. + /// This method checks if the specified object is an instance of + /// and compares their unique identifiers to determine if they represent the same audio device. /// /// A to compare. /// true if the two devices are equal; otherwise, false. @@ -359,7 +405,10 @@ public override bool Equals(object obj) } /// - /// Gets the hash code for this instance of . + /// Retrieves the hash code for the current instance of . + /// This method generates a hash code based on the unique identifier of the audio device, + /// which can be useful for storing instances in hash-based collections such as dictionaries + /// or hash sets. /// /// The hash code for this instance of . /// 4 diff --git a/src/Tizen.Multimedia/AudioManager/AudioDeviceConnectionChangedEventArgs.cs b/src/Tizen.Multimedia/AudioManager/AudioDeviceConnectionChangedEventArgs.cs index a35b013331b..2e1e26dca88 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioDeviceConnectionChangedEventArgs.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioDeviceConnectionChangedEventArgs.cs @@ -20,6 +20,12 @@ namespace Tizen.Multimedia { /// /// Provides data for the event. + /// This event is triggered when there is a change in the connection status of an audio device, + /// such as when a device is connected or disconnected from the system. + /// The class encapsulates information + /// about the device involved in the connection change and its current connection state, + /// allowing developers to easily respond to changes in the audio subsystem and update + /// application behavior accordingly. /// /// 3 public class AudioDeviceConnectionChangedEventArgs : EventArgs @@ -31,14 +37,23 @@ internal AudioDeviceConnectionChangedEventArgs(AudioDevice device, bool isConnec } /// - /// Gets the device. + /// Gets the device that is involved in the connection change. + /// This property returns an instance of , which represents + /// the specific audio device that has been connected or disconnected. + /// This information is essential for applications that need to manage multiple audio devices, + /// allowing them to identify the affected device and adjust their functionality accordingly. /// /// The . /// 3 public AudioDevice Device { get; } /// - /// Gets the connection state of the device. + /// Gets the current connection state of the device. + /// This property indicates whether the audio device is currently connected to the system. + /// It will return true if the device is connected and false if it has + /// been disconnected. This information is crucial for determining the audio routing and + /// playback options, enabling applications to appropriately react to the presence + /// or absence of audio devices in the environment. /// /// true if the device is connected; otherwise, false. /// 3 diff --git a/src/Tizen.Multimedia/AudioManager/AudioDeviceIoDirection.cs b/src/Tizen.Multimedia/AudioManager/AudioDeviceIoDirection.cs index 26a2c89b4f7..08dfb462c42 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioDeviceIoDirection.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioDeviceIoDirection.cs @@ -17,7 +17,9 @@ namespace Tizen.Multimedia { /// - /// Specifies the audio device directions. + /// Defines the data flow directions for audio devices, indicating whether + /// a device is for input, output, or both. This helps in managing audio + /// interactions within applications effectively. /// /// 3 public enum AudioDeviceIoDirection diff --git a/src/Tizen.Multimedia/AudioManager/AudioDeviceRunningChangedEventArgs.cs b/src/Tizen.Multimedia/AudioManager/AudioDeviceRunningChangedEventArgs.cs index 795d2eeb017..98a8554b97c 100755 --- a/src/Tizen.Multimedia/AudioManager/AudioDeviceRunningChangedEventArgs.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioDeviceRunningChangedEventArgs.cs @@ -19,7 +19,11 @@ namespace Tizen.Multimedia { /// - /// Provides data for the event. + /// Provides the data for the event, + /// which is triggered when the running state of an audio device changes. + /// This class encapsulates information about the specific audio device + /// that has undergone a state change, as well as its current running status, + /// allowing subscribers to respond appropriately to changes in audio device activity. /// /// 5 public class AudioDeviceRunningChangedEventArgs : EventArgs @@ -44,4 +48,4 @@ internal AudioDeviceRunningChangedEventArgs(AudioDevice device, bool isRunning) /// 5 public bool IsRunning { get; } } -} \ No newline at end of file +} diff --git a/src/Tizen.Multimedia/AudioManager/AudioDeviceType.cs b/src/Tizen.Multimedia/AudioManager/AudioDeviceType.cs index 7fd9822e1a5..f6e4199159c 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioDeviceType.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioDeviceType.cs @@ -17,58 +17,75 @@ namespace Tizen.Multimedia { /// - /// Specifies the audio device types. + /// Represents the various types of audio devices available in the system. + /// This enumeration categorizes audio devices based on their functionality and + /// connection type, enabling developers to easily identify and utilize + /// the appropriate audio device for their applications. The types include + /// built-in speakers and microphones, external connections like audio jacks, + /// Bluetooth, HDMI, USB audio, and network audio devices, facilitating + /// effective audio management in diverse scenarios. /// /// 3 public enum AudioDeviceType { /// - /// Built-in speaker. + /// Represents the built-in speaker of the device, typically used for + /// playback of audio through the device's internal audio output. /// BuiltinSpeaker, /// - /// Built-in receiver. + /// Represents the built-in receiver, usually utilized for phone calls + /// and communication through the device, providing audio input and output. /// BuiltinReceiver, /// - /// Built-in microphone. + /// Represents the built-in microphone, used for capturing audio input + /// from the environment, such as for voice commands, calls, or recordings. /// BuiltinMic, /// - /// Audio jack that can be connected to wired accessories such as headphones and headsets. + /// Indicates an audio jack that allows the connection of wired accessories + /// such as headphones and headsets, providing a physical interface for + /// audio playback and recording. /// AudioJack, /// - /// Bluetooth media (A2DP). + /// Represents Bluetooth media devices using the A2DP (Advanced Audio + /// Distribution Profile) standard for streaming high-quality audio wirelessly. /// BluetoothMedia, /// - /// HDMI. + /// Represents HDMI audio output, allowing the transmission of high-fidelity + /// audio and video to external displays or audio receivers through an HDMI cable. /// Hdmi, /// - /// Device for forwarding. + /// Represents devices used for forwarding audio data, which may involve + /// relaying audio signals to other devices or systems for processing or playback. /// Forwarding, /// - /// USB audio. + /// Represents USB audio devices, which connect through USB ports to provide + /// audio input and output, such as external sound cards or USB microphones. /// UsbAudio, /// - /// Bluetooth voice (SCO). + /// Represents Bluetooth voice devices using the SCO (Synchronous Connection + /// Oriented) profile, primarily used for voice communication over Bluetooth. /// BluetoothVoice, /// - /// Device for the transmission of audio data over a network + /// Represents devices that transmit audio data over a network, enabling audio + /// streaming or communication over internet or local networks. /// Network } diff --git a/src/Tizen.Multimedia/AudioManager/AudioDucking.cs b/src/Tizen.Multimedia/AudioManager/AudioDucking.cs index 3934a926887..e45ddc4240c 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioDucking.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioDucking.cs @@ -20,7 +20,10 @@ namespace Tizen.Multimedia { /// - /// Provides the functionalities to control audio ducking. + /// Controls audio ducking for specific audio streams, allowing for dynamic + /// adjustment of audio levels during playback. This class enables the activation + /// and deactivation of ducking, monitors ducking state changes, and ensures proper + /// privileges are in place for volume adjustments. /// /// /// 6 @@ -31,7 +34,9 @@ public sealed class AudioDucking : IDisposable private Interop.AudioDucking.DuckingStateChangedCallback _duckingStateChangedCallback; /// - /// Initializes a new instance of the class with . + /// Initializes a new instance of the class for a specified audio stream type. + /// This constructor sets up the audio ducking mechanism for the target stream, allowing + /// the application to respond to ducking state changes. /// /// The type of sound stream affected by this new instance. /// is invalid. @@ -54,13 +59,16 @@ public AudioDucking(AudioStreamType targetType) } /// - /// Occurs when the ducking state is changed. + /// Occurs when the ducking state of the audio stream changes, + /// notifying subscribers of the current ducking status. /// /// 6 public event EventHandler DuckingStateChanged; /// - /// Gets the ducking state of the stream. + /// Gets a value indicating whether the audio stream is currently ducked. + /// This property checks the ducking state and returns true if the audio + /// level is lowered; otherwise, false. /// /// true if the audio stream is ducked; otherwise, false. /// Operation failed; internal error. @@ -83,7 +91,9 @@ public bool IsDucked } /// - /// Activate audio ducking + /// Activates audio ducking for a specified duration and volume ratio. + /// This method lowers the audio level of the target stream for a defined + /// period, enabling a smoother audio experience during events like notifications. /// /// The duration for ducking in milliseconds. /// The volume ratio when ducked. @@ -124,7 +134,9 @@ public void Activate(uint duration, double ratio) } /// - /// Deactivate audio ducking + /// Deactivates audio ducking, restoring the audio levels of the target stream + /// to their original state. This method is used to stop the ducking effect + /// applied earlier when needed. /// /// To deactivate ducking, the specified privilege is required. /// http://tizen.org/privilege/volume.set @@ -148,7 +160,9 @@ public void Deactivate() } /// - /// Releases all resources used by the . + /// Releases all resources used by the instance. + /// This method clears any allocated resources and should be called when + /// the object is no longer needed. /// /// 6 public void Dispose() @@ -179,4 +193,4 @@ internal AudioDuckingHandle Handle } } } -} \ No newline at end of file +} diff --git a/src/Tizen.Multimedia/AudioManager/AudioDuckingStateChangedEventArgs.cs b/src/Tizen.Multimedia/AudioManager/AudioDuckingStateChangedEventArgs.cs index 484f794b8b3..7e9e2f3e9ae 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioDuckingStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioDuckingStateChangedEventArgs.cs @@ -19,7 +19,9 @@ namespace Tizen.Multimedia { /// - /// Provides data for the state change event of . + /// Represents the event data for the event, + /// which is triggered when the ducking state of an audio stream changes. + /// This class provides information about whether the audio stream is currently ducked or not. /// /// 6 public class AudioDuckingStateChangedEventArgs : EventArgs @@ -30,7 +32,10 @@ internal AudioDuckingStateChangedEventArgs(bool isDucked) } /// - /// Gets the ducking state of the stream. + /// Gets a value indicating whether the audio stream is currently in a ducked state. + /// This property reflects the status of the audio stream, where true + /// signifies that the audio level has been lowered, and false indicates + /// that the audio is at its normal level. /// /// true if the state is ducked; otherwise, false. /// 6 diff --git a/src/Tizen.Multimedia/AudioManager/AudioManager.cs b/src/Tizen.Multimedia/AudioManager/AudioManager.cs index 4b848c94233..4bb63d80107 100755 --- a/src/Tizen.Multimedia/AudioManager/AudioManager.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioManager.cs @@ -21,7 +21,10 @@ namespace Tizen.Multimedia { /// - /// Provides the ability to control volume levels and monitor audio devices. + /// Provides functionality to control volume levels and monitor the status of audio devices within the system. + /// The class enables developers to retrieve the volume controller, + /// obtain a list of currently connected audio devices, and subscribe to events related to device connection changes + /// as well as audio stream status changes, thereby facilitating comprehensive audio management. /// /// 3 public static class AudioManager @@ -32,14 +35,20 @@ static AudioManager() } /// - /// Gets the volume controller. + /// Gets the volume controller, which allows for adjustment and retrieval of the current audio volume level. + /// This property provides access to methods and properties that enable developers to manage volume settings + /// for different audio streams and ensure that the audio experience meets user preferences. /// /// The . /// 3 public static AudioVolume VolumeController { get; } /// - /// Gets the all devices currently connected. + /// Retrieves a collection of all audio devices currently connected to the system. + /// This method returns an , allowing developers to easily enumerate + /// through all available audio devices, such as speakers, microphones, and headphones. + /// It is useful for applications that need to adapt to changes in the audio environment or support + /// multiple audio output/input devices. /// /// An IEnumerable<AudioDevice> that contains connected devices. /// 4 @@ -94,7 +103,9 @@ IEnumerable RetrieveDevices() private static readonly object _audioDeviceConnectionLock = new object(); /// - /// Occurs when the state of a connection of an audio device changes. + /// Occurs when the state of an audio device connection changes, such as when a device is connected or disconnected. + /// Subscribing to this event allows developers to be notified of changes in the audio setup, enabling + /// dynamic adjustments in the application to accommodate new devices or handle disconnections accordingly. /// /// 3 public static event EventHandler DeviceConnectionChanged @@ -160,7 +171,12 @@ private static void UnregisterDeviceConnectionChangedEvent() private static readonly object _audioDeviceRunningLock = new object(); /// - /// Occurs when the audio stream started actually to run on the device. + /// Occurs when an audio stream starts running on a connected audio device. + /// This event is triggered when a new audio stream begins after all previous streams have stopped. + /// It is important to note that if this event is invoked while an audio stream is still running, + /// it will not be triggered again until all streams have been stopped and a new one starts. + /// This is especially useful for managing audio playback scenarios where multiple audio streams + /// may be played sequentially. /// /// /// If this event is invoked once and the audio stream is still running on the device,
diff --git a/src/Tizen.Multimedia/AudioManager/AudioPolicyException.cs b/src/Tizen.Multimedia/AudioManager/AudioPolicyException.cs index c0113f81019..33a5a24a1a8 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioPolicyException.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioPolicyException.cs @@ -19,13 +19,18 @@ namespace Tizen.Multimedia { /// - /// The exception that is thrown when noncompliance with the sound system policy happens. + /// Represents an exception that is thrown when there is a violation of the sound system policy. + /// This exception indicates that an operation has attempted to perform an action that + /// is not compliant with the established audio policies, which may affect audio playback or + /// manipulation within the application. /// /// 4 public class AudioPolicyException : InvalidOperationException { /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class + /// without any error message. This constructor is typically used when the + /// exception is thrown without specific details about the error. /// /// 4 public AudioPolicyException() @@ -33,7 +38,10 @@ public AudioPolicyException() } /// - /// Initializes a new instance of the class with a specified error message. + /// Initializes a new instance of the class + /// with a specified error message. This message provides additional context + /// regarding the reason for the exception, which can be useful for debugging + /// and logging purposes. /// /// The error message that explains the reason for the exception. /// 4 @@ -42,7 +50,9 @@ public AudioPolicyException(string message) : base(message) } /// - /// Initializes a new instance of the class with a specified error message and inner exception. + /// Initializes a new instance of the class + /// with a specified error message and a reference to the inner exception + /// that is the cause of this exception. /// /// The error message that explains the reason for the exception. /// The exception that is the cause of the current exception.. diff --git a/src/Tizen.Multimedia/AudioManager/AudioSampleFormat.cs b/src/Tizen.Multimedia/AudioManager/AudioSampleFormat.cs index c679adcfc2c..1c1fc36a95f 100755 --- a/src/Tizen.Multimedia/AudioManager/AudioSampleFormat.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioSampleFormat.cs @@ -19,26 +19,42 @@ namespace Tizen.Multimedia /// /// Specifies the audio sample formats. /// + /// + /// Enumerates the various audio sample formats that are supported in the audio + /// processing system. Each format represents a different way that audio signal + /// data can be encoded and represented in memory. + /// /// 5 public enum AudioSampleFormat { /// - /// Unsigned 8 bit samples. + /// Represents audio samples encoded as unsigned 8-bit integers. + /// This format is often used in low-quality audio files and + /// applications where bandwidth or storage space is limited. /// U8, /// - /// Signed 16 bit samples. + /// Represents audio samples encoded as signed 16-bit integers in + /// little-endian format. This format is commonly used in CD-quality + /// audio, providing a good balance between audio fidelity and file size. /// S16LE, /// - /// Signed 24 bit samples. + /// Represents audio samples encoded as signed 24-bit integers in + /// little-endian format. This high-resolution format allows for greater + /// dynamic range and fidelity, making it suitable for professional audio + /// applications and high-quality sound recordings. /// S24LE, /// - /// Signed 24 bit(packed in 32 bit) samples. + /// Represents audio samples encoded as signed 24-bit integers, + /// packed into 32-bit containers in little-endian format. This format + /// can be used for applications that require compatibility with 32-bit + /// processing, allowing for easier manipulation of samples at the cost of + /// additional space. /// S24PackedIn32LE, } diff --git a/src/Tizen.Multimedia/AudioManager/AudioStreamBehaviors.cs b/src/Tizen.Multimedia/AudioManager/AudioStreamBehaviors.cs index d9c3621d15d..b991c90dbec 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioStreamBehaviors.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioStreamBehaviors.cs @@ -19,7 +19,9 @@ namespace Tizen.Multimedia { /// - /// Specifies the flags for the audio stream behaviors. + /// Defines the flags that specify the behaviors of audio streams. + /// This enumeration allows for a bitwise combination of its member values, + /// enabling flexible configurations for audio playback and management. /// /// This enumeration has a attribute that allows a bitwise combination of its member values. /// @@ -29,12 +31,18 @@ namespace Tizen.Multimedia public enum AudioStreamBehaviors { /// - /// No Resume. + /// Indicates that the audio stream should not resume automatically + /// after being paused or stopped. This flag can be used when + /// explicit control over playback is desired, requiring the application + /// to manually manage the resumption of audio playback. /// NoResume = 0x0001, /// - /// Fading. + /// Indicates that the audio stream should apply a fading effect + /// during transitions. This behavior is useful for creating smoother + /// audio experiences, such as gradually lowering the volume before + /// stopping or increasing the volume when starting playback. /// Fading = 0x0002 } diff --git a/src/Tizen.Multimedia/AudioManager/AudioStreamFocusChangedReason.cs b/src/Tizen.Multimedia/AudioManager/AudioStreamFocusChangedReason.cs index 2cc6a7cefff..13b398e0193 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioStreamFocusChangedReason.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioStreamFocusChangedReason.cs @@ -17,7 +17,9 @@ namespace Tizen.Multimedia { /// - /// Specifies the change reasons of the audio stream focus state. + /// Enumerates the reasons for changes in the focus state of an audio stream. + /// This enumeration provides specific contexts in which the audio stream + /// focus may be gained or lost, ensuring developers can respond appropriately. /// /// 3 public enum AudioStreamFocusChangedReason diff --git a/src/Tizen.Multimedia/AudioManager/AudioStreamFocusOptions.cs b/src/Tizen.Multimedia/AudioManager/AudioStreamFocusOptions.cs index efd6680a6d2..d6f58252a8d 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioStreamFocusOptions.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioStreamFocusOptions.cs @@ -19,7 +19,10 @@ namespace Tizen.Multimedia { /// - /// Specifies the flags for the audio stream focus options. + /// Defines the flags for configuring audio stream focus options. + /// This enumeration allows developers to specify different behaviors + /// regarding how audio focus should be managed within an application + /// or among multiple audio streams. /// /// This enumeration has a attribute that allows a bitwise combination of its member values. /// diff --git a/src/Tizen.Multimedia/AudioManager/AudioStreamFocusState.cs b/src/Tizen.Multimedia/AudioManager/AudioStreamFocusState.cs index 4872792eb2f..597a1d6c52a 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioStreamFocusState.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioStreamFocusState.cs @@ -17,7 +17,10 @@ namespace Tizen.Multimedia { /// - /// Specifies the audio stream focus states. + /// Represents the various states of audio stream focus within an application. + /// This enumeration defines the focus states that can be utilized to manage + /// audio playback effectively, ensuring that developers can track and respond + /// to changes in audio focus, which is crucial in multi-stream environments. /// /// 3 public enum AudioStreamFocusState diff --git a/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs b/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs index 0d8ada32706..742dad82524 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs @@ -22,7 +22,10 @@ namespace Tizen.Multimedia { /// - /// Provides the ability to control the sound stream. + /// Provides functionalities to control and manage sound streams within an application. + /// The class enables developers to set policies for + /// playback and recording audio streams, adjusting settings for focus and routing, + /// as well as configuring audio devices and sound effects. /// /// 3 public class AudioStreamPolicy : IDisposable @@ -64,7 +67,9 @@ public AudioStreamPolicy(AudioStreamType streamType) } /// - /// Occurs when the state of focus that belongs to the current AudioStreamPolicy is changed. + /// Occurs when the state of focus for the current changes. + /// This event allows subscribers to react to changes in audio focus state, + /// helping to manage audio playback or recording effectively. /// /// /// The event is raised in the internal thread. diff --git a/src/Tizen.Multimedia/AudioManager/SoundEffect.cs b/src/Tizen.Multimedia/AudioManager/SoundEffect.cs index 25f6277eb02..5e6356e7e11 100644 --- a/src/Tizen.Multimedia/AudioManager/SoundEffect.cs +++ b/src/Tizen.Multimedia/AudioManager/SoundEffect.cs @@ -19,59 +19,73 @@ namespace Tizen.Multimedia { /// - /// Specifies the sound effect types. + /// Defines the various types of sound effects that can be applied to audio processing. + /// Each sound effect type serves a specific purpose in enhancing audio quality for different scenarios. /// /// 12 public enum SoundEffectType { /// - /// Noise suppression for voice call. + /// Applies noise suppression specifically designed for voice calls, + /// reducing background noise to enhance the clarity of the speaker's voice. /// NoiseSuppression, /// - /// Auto Gain Control for normal capturing. + /// Implements Auto Gain Control (AGC) to automatically adjust the audio levels + /// during normal audio capturing, ensuring consistent volume regardless of input variations. /// AutoGainControl, /// - /// Noise suppression + Auto Gain Control. + /// Combines both Noise Suppression and Auto Gain Control, + /// providing a comprehensive solution for clear and balanced audio during calls or recordings. /// NsWithAgc, /// - /// Includes the output sound from the reference device in the recorded audio. + /// Captures and includes the output sound from a reference audio device + /// in the recorded audio, allowing for enhanced audio mixing and playback. j + /// This effect is particularly useful when used with . /// /// - /// This effect should be used with . + /// This effect should be used in conjunction with + /// to specify the audio source from which the reference sound is taken. /// ReferenceCopy = 0x1001, /// - /// AEC (Acoustic Echo Cancellation) with Speex. + /// Implements Acoustic Echo Cancellation (AEC) using the Speex algorithm, + /// which helps to eliminate echo and improve voice clarity during calls or recordings. /// /// - /// This effect should be used with . + /// This effect should be used with + /// to optimize echo cancellation based on the reference audio input. /// AecSpeex, /// - /// AEC (Acoustic Echo Cancellation) with WebRTC. + /// Utilizes the WebRTC algorithm for Acoustic Echo Cancellation (AEC), + /// effectively reducing echo and enhancing the quality of audio communications. /// /// - /// This effect should be used with . + /// This effect should be used together with + /// to ensure optimal performance in echo cancellation. /// AecWebrtc } /// - /// Specifies the sound effect information. + /// Represents the configuration and parameters for applying sound effects to audio processing. + /// This structure allows you to specify the type of sound effect and, if necessary, + /// a reference audio device to enhance the audio processing capabilities. /// /// 12 public struct SoundEffectInfo { /// - /// Initializes a new instance of . + /// Initializes a new instance of the structure + /// with the specified sound effect type. The reference device is set to null. /// /// The SoundEffectType. /// Invalid input enum type. @@ -85,7 +99,9 @@ public SoundEffectInfo(SoundEffectType type) } /// - /// Initializes a new instance of with a reference audio device. + /// Initializes a new instance of the structure + /// with the specified sound effect type and a reference audio device. + /// This allows for enhanced audio processing by using additional audio data from the specified device. /// /// The SoundEffectType. /// The AudioDevice to be refered. @@ -99,13 +115,13 @@ public SoundEffectInfo(SoundEffectType type, AudioDevice device) } /// - /// The SoundEffectType. + /// Gets the type of sound effect that will be applied, as specified in the enum. /// /// 12 public SoundEffectType Type { get; } /// - /// The AudioDevice used by the SoundEffect as additional source of audio data. + /// Gets the reference audio device used by the sound effect as an additional source of audio data. /// /// 12 public AudioDevice ReferenceDevice { get; }