MiracastReceiverStreamControl.SuggestVideoStreamSettingsAsync Method

Reference

Definition

Namespace:: Windows.Media.Miracast

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.

Edit

Asynchronously suggests an appropriate width, height and bitrate to the Miracast Transmitter.

public:
 virtual IAsyncAction ^ SuggestVideoStreamSettingsAsync(MiracastReceiverVideoStreamSettings ^ settings) = SuggestVideoStreamSettingsAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncAction SuggestVideoStreamSettingsAsync(MiracastReceiverVideoStreamSettings const& settings);

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncAction SuggestVideoStreamSettingsAsync(MiracastReceiverVideoStreamSettings settings);

function suggestVideoStreamSettingsAsync(settings)

Public Function SuggestVideoStreamSettingsAsync (settings As MiracastReceiverVideoStreamSettings) As IAsyncAction

Parameters

settings: MiracastReceiverVideoStreamSettings

A MiracastReceiverVideoStreamSettings object representing the suggested settings.

Returns

IAsyncAction

An asynchronous task.

Attributes: RemoteAsyncAttribute

Remarks

An app can call this API when the MediaPlayerElement associated with the Miracast content changes. By default, Miracast tries to use a 1920x1080 resolution, or a 4k resolution if supported by the hardware. By asking the transmitter to use a lower resolution, it might be possible to reduce the network bandwidth used.

The settings passed into the method are suggestions that the transmitter may or may not adopt. To find out the actual values chosen by the receiver, call GetVideoStreamSettingsAsync.

This function accesses member variables without locking, so it should be invoked on the UI thread in a call to CoreDispatcher.RunAsync

Applies to

Share via