Clipboard.SetAudio Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Clears the Clipboard and then adds data in the WaveAudio format, replacing the existing data.

Overloads

SetAudio(Byte[])	Clears the Clipboard and then adds a Byte array in the WaveAudio format after converting it to a Stream.
SetAudio(Stream)	Clears the Clipboard and then adds a Stream in the WaveAudio format.

SetAudio(Byte[])

Source:

Clipboard.cs

Clears the Clipboard and then adds a Byte array in the WaveAudio format after converting it to a Stream.

public:
 static void SetAudio(cli::array <System::Byte> ^ audioBytes);

public static void SetAudio (byte[] audioBytes);

static member SetAudio : byte[] -> unit

Public Shared Sub SetAudio (audioBytes As Byte())

Parameters

audioBytes

Byte[]

A Byte array containing the audio data.

Exceptions

ExternalException

The Clipboard could not be cleared. This typically occurs when the Clipboard is being used by another process.

ThreadStateException

The current thread is not in single-threaded apartment (STA) mode. Add the STAThreadAttribute to your application's Main method.

ArgumentNullException

audioBytes is null.

Examples

The following example demonstrates an overload of the SetAudio method that is similar to this overload.

// Demonstrates SetAudio, ContainsAudio, and GetAudioStream.
public System.IO.Stream SwapClipboardAudio(
    System.IO.Stream replacementAudioStream)
{
    System.IO.Stream returnAudioStream = null;
    if (Clipboard.ContainsAudio())
    {
        returnAudioStream = Clipboard.GetAudioStream();
        Clipboard.SetAudio(replacementAudioStream);
    }
    return returnAudioStream;
}

' Demonstrates SetAudio, ContainsAudio, and GetAudioStream.
Public Function SwapClipboardAudio( _
    ByVal replacementAudioStream As System.IO.Stream) _
    As System.IO.Stream

    Dim returnAudioStream As System.IO.Stream = Nothing

    If (Clipboard.ContainsAudio()) Then
        returnAudioStream = Clipboard.GetAudioStream()
        Clipboard.SetAudio(replacementAudioStream)
    End If

    Return returnAudioStream

End Function

Remarks

To retrieve audio data from the Clipboard, first use the ContainsAudio method to determine whether the Clipboard contains audio data before retrieving it with the GetAudioStream method.

Note

The Clipboard class can only be used in threads set to single thread apartment (STA) mode. To use this class, ensure that your Main method is marked with the STAThreadAttribute attribute.

See also

• WaveAudio
• ContainsAudio()
• GetAudioStream()

SetAudio(Stream)

Source:

Clipboard.cs

Clears the Clipboard and then adds a Stream in the WaveAudio format.

public:
 static void SetAudio(System::IO::Stream ^ audioStream);

public static void SetAudio (System.IO.Stream audioStream);

static member SetAudio : System.IO.Stream -> unit

Public Shared Sub SetAudio (audioStream As Stream)

Parameters

audioStream

Stream

A Stream containing the audio data.

Exceptions

ExternalException

The Clipboard could not be cleared. This typically occurs when the Clipboard is being used by another process.

ThreadStateException

The current thread is not in single-threaded apartment (STA) mode. Add the STAThreadAttribute to your application's Main method.

ArgumentNullException

audioStream is null.

Examples

The following example demonstrates this member.

// Demonstrates SetAudio, ContainsAudio, and GetAudioStream.
public System.IO.Stream SwapClipboardAudio(
    System.IO.Stream replacementAudioStream)
{
    System.IO.Stream returnAudioStream = null;
    if (Clipboard.ContainsAudio())
    {
        returnAudioStream = Clipboard.GetAudioStream();
        Clipboard.SetAudio(replacementAudioStream);
    }
    return returnAudioStream;
}

' Demonstrates SetAudio, ContainsAudio, and GetAudioStream.
Public Function SwapClipboardAudio( _
    ByVal replacementAudioStream As System.IO.Stream) _
    As System.IO.Stream

    Dim returnAudioStream As System.IO.Stream = Nothing

    If (Clipboard.ContainsAudio()) Then
        returnAudioStream = Clipboard.GetAudioStream()
        Clipboard.SetAudio(replacementAudioStream)
    End If

    Return returnAudioStream

End Function

Remarks

To retrieve audio data from the Clipboard, first use the ContainsAudio method to determine whether the Clipboard contains audio data before retrieving it with the GetAudioStream method.

Note

The Clipboard class can only be used in threads set to single thread apartment (STA) mode. To use this class, ensure that your Main method is marked with the STAThreadAttribute attribute.

See also

• WaveAudio
• ContainsAudio()
• GetAudioStream()