MediaComposition.RenderToFileAsync Method

  • Reference

Definition

Namespace:
Windows.Media.Editing

Overloads

RenderToFileAsync(IStorageFile)

Asynchronously renders the MediaComposition to the specified file.
RenderToFileAsync(IStorageFile, MediaTrimmingPreference)

Asynchronously renders the MediaComposition to a specified file using the indicated media trimming preference.
RenderToFileAsync(IStorageFile, MediaTrimmingPreference, MediaEncodingProfile)

Asynchronously renders the MediaComposition to a specified file using the indicated media trimming preference and encoding profile.

RenderToFileAsync(IStorageFile)

Edit

Asynchronously renders the MediaComposition to the specified file.

public:
 virtual IAsyncOperationWithProgress<TranscodeFailureReason, double> ^ RenderToFileAsync(IStorageFile ^ destination) = RenderToFileAsync;
/// [Windows.Foundation.Metadata.Overload("RenderToFileAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperationWithProgress<TranscodeFailureReason, double> RenderToFileAsync(IStorageFile const& destination);
[Windows.Foundation.Metadata.Overload("RenderToFileAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperationWithProgress<TranscodeFailureReason,double> RenderToFileAsync(IStorageFile destination);
function renderToFileAsync(destination)
Public Function RenderToFileAsync (destination As IStorageFile) As IAsyncOperationWithProgress(Of TranscodeFailureReason, Double)

Parameters

destination
IStorageFile

The file to which this MediaComposition is rendered.

Returns

IAsyncOperationWithProgress<TranscodeFailureReason,Double>

IAsyncOperationWithProgress<TranscodeFailureReason,double>

An async operation which can be used to track the success or failure of the operation.

Attributes
OverloadAttribute RemoteAsyncAttribute

Remarks

This method saves the composition to a video file that can be played back with standard media players. If you want to save the composition as an XML file that can be loaded and modified in the future, use SaveAsync.

See also

Applies to

RenderToFileAsync(IStorageFile, MediaTrimmingPreference)

Edit

Asynchronously renders the MediaComposition to a specified file using the indicated media trimming preference.

public:
 virtual IAsyncOperationWithProgress<TranscodeFailureReason, double> ^ RenderToFileAsync(IStorageFile ^ destination, MediaTrimmingPreference trimmingPreference) = RenderToFileAsync;
/// [Windows.Foundation.Metadata.Overload("RenderToFileWithTrimmingPreferenceAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperationWithProgress<TranscodeFailureReason, double> RenderToFileAsync(IStorageFile const& destination, MediaTrimmingPreference const& trimmingPreference);
[Windows.Foundation.Metadata.Overload("RenderToFileWithTrimmingPreferenceAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperationWithProgress<TranscodeFailureReason,double> RenderToFileAsync(IStorageFile destination, MediaTrimmingPreference trimmingPreference);
function renderToFileAsync(destination, trimmingPreference)
Public Function RenderToFileAsync (destination As IStorageFile, trimmingPreference As MediaTrimmingPreference) As IAsyncOperationWithProgress(Of TranscodeFailureReason, Double)

Parameters

destination
IStorageFile

The file to which this MediaComposition is rendered.

trimmingPreference
MediaTrimmingPreference

Specifies whether to be fast or precise when trimming the media.

Returns

IAsyncOperationWithProgress<TranscodeFailureReason,Double>

IAsyncOperationWithProgress<TranscodeFailureReason,double>

An async operation which can be used to track the success or failure of the operation.

Attributes
OverloadAttribute RemoteAsyncAttribute

Remarks

This method saves the composition to a video file that can be played back with standard media players. If you want to save the composition as an XML file that can be loaded and modified in the future, use SaveAsync.

See also

Applies to

RenderToFileAsync(IStorageFile, MediaTrimmingPreference, MediaEncodingProfile)

Edit

Asynchronously renders the MediaComposition to a specified file using the indicated media trimming preference and encoding profile.

public:
 virtual IAsyncOperationWithProgress<TranscodeFailureReason, double> ^ RenderToFileAsync(IStorageFile ^ destination, MediaTrimmingPreference trimmingPreference, MediaEncodingProfile ^ encodingProfile) = RenderToFileAsync;
/// [Windows.Foundation.Metadata.Overload("RenderToFileWithProfileAsync")]
IAsyncOperationWithProgress<TranscodeFailureReason, double> RenderToFileAsync(IStorageFile const& destination, MediaTrimmingPreference const& trimmingPreference, MediaEncodingProfile const& encodingProfile);
[Windows.Foundation.Metadata.Overload("RenderToFileWithProfileAsync")]
public IAsyncOperationWithProgress<TranscodeFailureReason,double> RenderToFileAsync(IStorageFile destination, MediaTrimmingPreference trimmingPreference, MediaEncodingProfile encodingProfile);
function renderToFileAsync(destination, trimmingPreference, encodingProfile)
Public Function RenderToFileAsync (destination As IStorageFile, trimmingPreference As MediaTrimmingPreference, encodingProfile As MediaEncodingProfile) As IAsyncOperationWithProgress(Of TranscodeFailureReason, Double)

Parameters

destination
IStorageFile

The file to which this MediaComposition is rendered.

trimmingPreference
MediaTrimmingPreference

Specifies whether to be fast or precise when trimming the media.

encodingProfile
MediaEncodingProfile

Specifies the encoding profile to use for rendering the media.

Returns

IAsyncOperationWithProgress<TranscodeFailureReason,Double>

IAsyncOperationWithProgress<TranscodeFailureReason,double>

An async operation which can be used to track the success or failure of the operation.

Attributes
OverloadAttribute

Remarks

This method saves the composition to a video file that can be played back with standard media players. If you want to save the composition as an XML file that can be loaded and modified in the future, use SaveAsync.

See also

Applies to