/// -or-<br/>
/// <paramref name="index"/> is equal to or greater than <see cref="Count"/>.
/// </exception>
- /// <exception cref="InvalidOperationException">
+ /// <exception cref="NotAvailableException">
/// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
/// </exception>
/// <since_tizen> 3 </since_tizen>
/// Clears the equalizer effect.
/// </summary>
/// <exception cref="ObjectDisposedException">The <see cref="Player"/> has already been disposed of.</exception>
- /// <exception cref="InvalidOperationException">
- /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// <exception cref="NotAvailableException">If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// -or-<br/>
+ /// <see cref="IsAvailable"/> returns false. (Since tizen 6.0)
/// </exception>
- /// <exception cref="NotAvailableException"><see cref="IsAvailable"/> returns false. (Since tizen 6.0)</exception>
/// <seealso cref="IsAvailable"/>
/// <since_tizen> 3 </since_tizen>
public void Clear()
/// <summary>
/// Gets the number of items.
/// </summary>
- /// <exception cref="InvalidOperationException">
- /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// <exception cref="NotAvailableException">If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// -or-<br/>
+ /// <see cref="IsAvailable"/> returns false. (Since tizen 6.0)
/// </exception>
- /// <exception cref="NotAvailableException"><see cref="IsAvailable"/> returns false. (Since tizen 6.0)</exception>
/// <seealso cref="IsAvailable"/>
/// <since_tizen> 3 </since_tizen>
public int Count
/// <summary>
/// Gets the range of band level in dB.
/// </summary>
- /// <exception cref="InvalidOperationException">
- /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// <exception cref="NotAvailableException">If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// -or-<br/>
+ /// <see cref="IsAvailable"/> returns false. (Since tizen 6.0)
/// </exception>
- /// <exception cref="NotAvailableException"><seealso cref="IsAvailable"/> returns false. (Since tizen 6.0)</exception>
/// <seealso cref="IsAvailable"/>
/// <since_tizen> 3 </since_tizen>
public Range BandLevelRange
/// Gets the value whether the AudioEffect is available or not.
/// </summary>
/// <remarks>This function returns the availability of the audio effect function group and
- /// it could be unavailable depending on the platform capabilities.</remarks>
- /// <exception cref="InvalidOperationException">
- /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// it could be unavailable depending on the platform capabilities.<br/>
+ /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>,
+ /// the <see cref="IsAvailable"/> returns false.(Since tizen 6.0)</remarks>
+ /// <exception cref="NotAvailableException">
+ /// The function is not available depending on the audio codec type. (Since tizen 6.0)
/// </exception>
- /// <exception cref="NotAvailableException">The function is not available depending on the audio codec type. (Since tizen 6.0)</exception>
+ /// <seealso cref="Player.AudioOffload"/>
/// <seealso cref="Player.AudioCodecType"/>
/// <since_tizen> 3 </since_tizen>
public bool IsAvailable
/// <remarks><para>The player lets the hardware decode and render the sound if the audio offload is enabled.
/// Audio offload can reduce the power consumption, but disable the ability to handle output PCM.
/// Please check the below list of functions which will not work if offloading is enabled.</para>
- /// <para>If audio offload is enabled, the following functions will return <see cref="InvalidOperationException"/>: <br/>
+ /// <para>If audio offload is enabled, the following functions will return <see cref="NotAvailableException"/>: <br/>
/// <see cref="AudioEffect"/><br/>
/// <see cref="EqualizerBand"/><br/>
/// <see cref="PlayerTrackInfo"/><br/>
/// <exception cref="ArgumentOutOfRangeException">
/// <paramref name="value"/> is not inside of <see cref="AudioEffect.BandLevelRange"/>.
/// </exception>
- /// <exception cref="InvalidOperationException">
+ /// <exception cref="NotAvailableException">
/// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
/// </exception>
/// <since_tizen> 3 </since_tizen>
/// <summary>
/// Gets the frequency in dB.
/// </summary>
- /// <exception cref="InvalidOperationException">
+ /// <exception cref="NotAvailableException">
/// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
/// </exception>
/// <since_tizen> 3 </since_tizen>
/// <summary>
/// Gets the frequency range in dB.
/// </summary>
- /// <exception cref="InvalidOperationException">
+ /// <exception cref="NotAvailableException">
/// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
/// </exception>
/// <since_tizen> 3 </since_tizen>
/// </remarks>
/// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
/// <exception cref="ArgumentException">The value is not valid.</exception>
- /// <exception cref="InvalidOperationException">
+ /// <exception cref="NotAvailableException">
/// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
/// </exception>
+ /// <seealso cref="AudioOffload"/>
/// <since_tizen> 3 </since_tizen>
public AudioLatencyMode AudioLatencyMode
{
/// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
/// <exception cref="InvalidOperationException">
/// The player is not in the valid state.
+ /// </exception>
+ /// <exception cref="NotAvailableException">If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
/// -or-<br/>
- /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// The function is not available depending on the audio codec type. (Since tizen 6.0)
/// </exception>
- /// <exception cref="NotAvailableException">The function is not available depending on the audio codec type. (Since tizen 6.0)</exception>
+ /// <seealso cref="AudioOffload"/>
/// <seealso cref="AudioCodecType"/>
/// <since_tizen> 5 </since_tizen>
public bool ReplayGain
/// This function could be unavailable depending on the audio codec type.</remarks>
/// <exception cref="InvalidOperationException">
/// The player is not in the valid state.
- /// -or-<br/>
- /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
/// </exception>
/// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
- /// <exception cref="NotAvailableException">The function is not available depending on the audio codec type. (Since tizen 6.0)</exception>
+ /// <exception cref="NotAvailableException">If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// -or-<br/>
+ /// The function is not available depending on the audio codec type. (Since tizen 6.0)
+ /// </exception>
/// <seealso cref="AudioPitch"/>
+ /// <seealso cref="AudioOffload"/>
/// <seealso cref="AudioCodecType"/>
/// <since_tizen> 6 </since_tizen>
public bool AudioPitchEnabled
/// This function could be unavailable depending on the audio codec type.</remarks>
/// <exception cref="InvalidOperationException">
/// A pitch is not enabled.
- /// -or-<br/>
- /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
/// </exception>
/// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
/// <exception cref="ArgumentOutOfRangeException">
/// value is less than 0.5.
/// -or-<br/>
- /// value is greater than 2.0.<br/>
+ /// value is greater than 2.0.
+ /// </exception>
+ /// <exception cref="NotAvailableException">If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// -or-<br/>
+ /// The function is not available depending on the audio codec type. (Since tizen 6.0)
/// </exception>
- /// <exception cref="NotAvailableException">The function is not available depending on the audio codec type. (Since tizen 6.0)</exception>
/// <seealso cref="AudioPitchEnabled"/>
+ /// <seealso cref="AudioOffload"/>
/// <seealso cref="AudioCodecType"/>
/// <since_tizen> 6 </since_tizen>
public float AudioPitch
/// The player is not in the valid state.<br/>
/// -or-<br/>
/// Streaming playback.
- /// -or-<br/>
- /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// <paramref name="rate"/> is less than -5.0.<br/>
/// -or-<br/>
/// <paramref name="rate"/> is zero.
/// </exception>
+ /// <exception cref="NotAvailableException">
+ /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// </exception>
+ /// <seealso cref="AudioOffload"/>
/// <since_tizen> 3 </since_tizen>
public void SetPlaybackRate(float rate)
{
/// Operation failed; internal error.
/// -or-<br/>
/// The player is not in the valid state.
- /// -or-<br/>
- /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
/// </exception>
- /// <exception cref="NotAvailableException">The function is not available depending on the audio codec type. (Since tizen 6.0)</exception>
+ /// <exception cref="NotAvailableException">If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// -or-<br/>
+ /// The function is not available depending on the audio codec type. (Since tizen 6.0)
+ /// </exception>
/// <seealso cref="PlayerAudioExtractOption"/>
/// <seealso cref="DisableExportingAudioData"/>
+ /// <seealso cref="AudioOffload"/>
/// <seealso cref="AudioCodecType"/>
/// <since_tizen> 6 </since_tizen>
public void EnableExportingAudioData(AudioMediaFormat format, PlayerAudioExtractOption option)
/// <see cref="PlayerState.Playing"/>, or <see cref="PlayerState.Paused"/> state.
/// </remarks>
/// <exception cref="ObjectDisposedException">The <see cref="Player"/> that this instance belongs to has been disposed of.</exception>
- /// <exception cref="InvalidOperationException">The <see cref="Player"/> that this instance belongs to is not in the valid state.
+ /// <exception cref="NotAvailableException">The <see cref="Player"/> that this instance belongs to is not in the valid state.
/// -or-<br/>
/// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
/// </exception>
/// </remarks>
/// <exception cref="ObjectDisposedException">The <see cref="Player"/> that this instance belongs to has been disposed of.</exception>
/// <exception cref="InvalidOperationException">The <see cref="Player"/> that this instance belongs to is not in the valid state.
- /// -or-<br/>
- /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// <paramref name="index"/> is less than zero.<br/>
/// -or-<br/>
/// <paramref name="index"/> is equal to or greater than <see cref="GetCount()"/>.
/// </exception>
+ /// <exception cref="NotAvailableException">
+ /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// </exception>
/// <since_tizen> 3 </since_tizen>
public string GetLanguageCode(int index)
{
/// </remarks>
/// <exception cref="ObjectDisposedException">The <see cref="Player"/> that this instance belongs to has been disposed of.</exception>
/// <exception cref="InvalidOperationException">
- /// The <see cref="Player"/> that this instance belongs to is not in the valid state.<br/>
- /// -or-<br/>
- /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// The <see cref="Player"/> that this instance belongs to is not in the valid state.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// <paramref name="value"/> is less than zero.<br/>
/// -or-<br/>
/// <paramref name="value"/> is equal to or greater than <see cref="GetCount()"/>.
/// </exception>
+ /// <exception cref="NotAvailableException">
+ /// If audio offload is enabled by calling <see cref="AudioOffload.IsEnabled"/>. (Since tizen 6.0)
+ /// </exception>
/// <since_tizen> 3 </since_tizen>
public int Selected
{
/// </exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaControllerManager"/> has already been disposed.</exception>
/// <since_tizen> 6 </since_tizen>
- public IEnumerable<Rotation> GetDisplayRotationapability()
+ public IEnumerable<Rotation> GetDisplayRotationCapability()
{
ThrowIfStopped();