GetAudioStream Method

Clipboard.GetAudioStream Method ()


Retrieves an audio stream from the Clipboard.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public static Stream GetAudioStream()

Return Value

Type: System.IO.Stream

A Stream containing audio data or null if the Clipboard does not contain any data in the WaveAudio format.

Exception Condition

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


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

Use the ContainsAudio method to determine whether the Clipboard contains audio data before retrieving it with this method.

Use the SetAudio method to add audio data to the Clipboard.


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.

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();
    return returnAudioStream;


for access to the system Clipboard. Associated enumeration: UIPermissionClipboard.AllClipboard

.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft