Clipboard.GetAudioStream Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Retrieves an audio stream from the Clipboard.
public:
static System::IO::Stream ^ GetAudioStream();public static System.IO.Stream GetAudioStream ();public static System.IO.Stream? GetAudioStream ();static member GetAudioStream : unit -> System.IO.StreamPublic Shared Function GetAudioStream () As StreamReturns
A Stream containing audio data or null if the Clipboard does not contain any data in the WaveAudio format.
Exceptions
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.
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
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.
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.
