Media Streaming API

Overview of the Media Streaming API technology.

To develop Media Streaming API, you need these headers:

For programming guidance for this technology, see:

Enumerations

 
ConnectionStatus

Represents the state of the device in the network as last seen.
DeviceTypes

Describes the DLNA device types that are supported by the Media Streaming API.
TransportState

Defines the available transport states as defined by the UPnP Guidelines.
TransportStatus

Defines the available transport status as defined by the UPnP Guidelines.

Functions

 
add_ConnectionStatusChanged

Registers an event handler for the ConnectionStatusChanged event.
add_DeviceArrival

Registers an event handler for the DeviceArrival event.
add_DeviceDeparture

Registers an event handler for the DeviceDeparture event.
add_RenderingParametersUpdate

Registers an event handler for the RenderingParametersUpdate event.
add_TransportParametersUpdate

Registers an event handler for the TransportParametersUpdate event.
AddDevice

Adds a DLNA DMR or DMS Device, identified by its UPnP Unique Device Name (UDN), to the list of devices that is returned by the CachedDevices method.
CloneBasicDeviceAsync

Asynchronously creates a clone of a basic device.
CreateBasicDeviceAsync

Asynchronously creates an active basic device.
CreateDevicesOnMatchingNetworkAsync

Asynchronously creates a DevicePair of devices that are on the same network interface.
CreateMediaRendererAsync

Asynchronously creates a new instance of an object that implements the IMediaRenderer interface using the specified Unique Device Name (UDN).
CreateMediaRendererFromBasicDeviceAsync

Asynchronously creates a new instance of an object that implements the IMediaRenderer interface using the specified IBasicDevice interface.
get_Renderer

Gets the renderer for the active basic device pair.
get_Server

Gets the server for the active basic device pair.
GetCachedBitrateMeasurement

Gets the cached bitrate.
GetCachedExtraSinkProtocolInfo

Gets additional cached sink protocol info for the device.
GetCachedSinkProtocolInfo

Gets the cached sink protocol info for the device.
GetDevicesOnMatchingNetworkAsync

Asynchronously gets a DevicePair of devices that are on the same network interface.
GetEffectiveBandwidth

Gets the current effective bandwidth for the device.
GetMuteAsync

Queries the DMR asynchronously to determine if audio is currently muted or unmuted.
GetPositionInformationAsync

Queries the DMR asynchronously to retrieve position information.
GetStreamPropertiesAsync

When implemented gets the properties of the stream asynchronously.
GetTransportInformationAsync

Queries the DMR asynchronously to retrieve transport information.
GetVolumeAsync

Queries the DMR asynchronously for its current audio volume level.
NotifyStreamingStatus

Called by the application to indicate that the device is being used for active streaming.
PauseAsync

Instructs the DMR asynchronously to pause playing the current content.
PlayAsync

Instructs the DMR asynchronously to play the content that was specified by calling the SetSourceFromUriAsync, SetSourceFromStreamAsync, or SetSourceFromMediaSourceAsync method.
PlayAtSpeedAsync

Instructs the DMR asynchronously to play the content that was specified by calling the SetSourceFromUriAsync, SetSourceFromStreamAsync, or SetSourceFromMediaSourceAsync method at the specified rate.
remove_ConnectionStatusChanged

Unregisters an event handler for the ConnectionStatusChanged event.
remove_DeviceArrival

Unregisters an event handler for the DeviceArrival event.
remove_DeviceDeparture

Unregisters an event handler for the DeviceDeparture event.
remove_RenderingParametersUpdate

Unregisters an event handler for the RenderingParametersUpdate event.
remove_TransportParametersUpdate

Unregisters an event handler for the TransportParametersUpdate event.
RemoveDevice

Removes the specified device from the list of devices that is returned by the CachedDevices method.
SeekAsync

Instructs the DMR asynchronously to seek to a particular time offset.
SelectBestStreamAsync

When implemented queries asynchronously for the best stream.
SetCachedBitrateMeasurement

Sets the cached bitrate.
SetCachedSinkProtocolInfo

Gets the cached sink protocol info for the device.
SetMuteAsync

Instructs the DMR asynchronously to either mute or unmute the audio.
SetNextSourceFromMediaSourceAsync

Instructs the DMR asynchronously to prepare the specified content for playing once the current content has finished playing.
SetNextSourceFromStreamAsync

Instructs the DMR asynchronously to prepare the specified media stream for playing once the current content has finished playing.
SetNextSourceFromUriAsync

Instructs the DMR asynchronously to prepare the content identified by the specified URI for playing once the current content has finished playing.
SetSourceFromMediaSourceAsync

Instructs the DMR asynchronously to prepare the specified content for playing.
SetSourceFromStreamAsync

Instructs the DMR asynchronously to prepare the specified media stream for playing.
SetSourceFromUriAsync

Instructs the DMR asynchronously to prepare the content identified by the specified URI for playing.
SetVolumeAsync

Sets the audio volume level on the DMR asynchronously to the specified value.
StopAsync

Instructs the DMR asynchronously to stop playing the current content.

Interfaces

 
IActiveBasicDevice

Represents an active IBasicDevice that is associated with a UPnP device.
IActiveBasicDeviceStatics

Provides static methods for creating IActiveBasicDevice objects.
IBasicDevice

Encapsulates the methods and events needed to model a DLNA Device.
IDeviceController

Encapsulates the methods and events needed to retrieve a list of cached Digital Media Renderers (DMRs) and/or Digital Media Servers (DMSs), or to asynchronously find the DMRs and/or DMSs that are currently on the network.
IDeviceIcon

Encapsulates the methods needed to provide information about the icon of a DLNA Device.
IDevicePair

Represents a pair of ActiveBasicDevice objects which is comprised of a renderer and a server.
IMediaRenderer

Encapsulates the methods and events needed to represent a DLNA Digital Media Renderer (DMR) device.
IMediaRendererActionInformation

Encapsulates the methods needed to provide information about what methods can currently be invoked on the DMR.
IMediaRendererFactory

Encapsulates the methods needed to asynchronously create a new instance of an object that implements the IMediaRenderer interface.
IStreamSelectorStatics

Encapsulates the methods needed to asynchronously select a stream.
ITransportParameters

Encapsulates the methods needed to provide information about the current transport-related settings of the DMR. These settings include the current transport state and information about what methods can currently be invoked on the DMR.

Structures

 
PlaySpeed

Represents a playback speed as a rational number.
PositionInformation

Contains the current values of media playback position information obtained from the DMR.
RenderingParameters

Contains the current values of rendering parameters on the DMR.
TrackInformation

Contains the current track number and duration as part of the PositionInformation obtained from the DMR.
TransportInformation

Contains the current values of media playback transport-related information obtained from the DMR.