BitmapEncoder.GoToNextFrameAsync Method

  • Reference

Definition

Namespace:
Windows.Graphics.Imaging

Overloads

GoToNextFrameAsync()

Asynchronously commits the current frame data and appends a new empty frame to be edited.
GoToNextFrameAsync(IIterable<KeyValuePair<String,BitmapTypedValue>>)

Asynchronously commits the current frame data and appends a new empty frame, with the specified encoding options, to be edited.

GoToNextFrameAsync()

Edit

Asynchronously commits the current frame data and appends a new empty frame to be edited.

public:
 virtual IAsyncAction ^ GoToNextFrameAsync() = GoToNextFrameAsync;
/// [Windows.Foundation.Metadata.Overload("GoToNextFrameAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncAction GoToNextFrameAsync();
[Windows.Foundation.Metadata.Overload("GoToNextFrameAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncAction GoToNextFrameAsync();
function goToNextFrameAsync()
Public Function GoToNextFrameAsync () As IAsyncAction

Returns

IAsyncAction

An object that manages the asynchronous operation of committing the current frame data and appending a new empty frame to be edited.

Attributes
OverloadAttribute RemoteAsyncAttribute

Remarks

After this method is called, data on the just-committed frame is no longer accessible. Instead, a new, empty frame is appended to the image and subsequent reads and writes on the BitmapEncoder will access this frame. You can't "rewind" to a previously committed frame.

Don't call this method if the current frame is intended to be the last frame in the image, as this will result in a superfluous, empty frame at the end of the image. Instead, call FlushAsync which will commit the frame and close the entire BitmapEncoder. For example, in most scenarios the application only needs to save a single-frame image. In these cases GoToNextFrameAsync should never be called.

The first time this method is called, all container level data as well as the first frame data is committed. Afterwards, any attempts to access container level data will fail.

See also

Applies to

GoToNextFrameAsync(IIterable<KeyValuePair<String,BitmapTypedValue>>)

Edit

Asynchronously commits the current frame data and appends a new empty frame, with the specified encoding options, to be edited.

public:
 virtual IAsyncAction ^ GoToNextFrameAsync(IIterable<IKeyValuePair<Platform::String ^, BitmapTypedValue ^> ^> ^ encodingOptions) = GoToNextFrameAsync;
/// [Windows.Foundation.Metadata.Overload("GoToNextFrameWithEncodingOptionsAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncAction GoToNextFrameAsync(IIterable<IKeyValuePair<winrt::hstring, BitmapTypedValue const&>> const& encodingOptions);
[Windows.Foundation.Metadata.Overload("GoToNextFrameWithEncodingOptionsAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncAction GoToNextFrameAsync(IEnumerable<KeyValuePair<string,BitmapTypedValue>> encodingOptions);
function goToNextFrameAsync(encodingOptions)
Public Function GoToNextFrameAsync (encodingOptions As IEnumerable(Of KeyValuePair(Of String, BitmapTypedValue))) As IAsyncAction

Parameters

encodingOptions

IIterable<IKeyValuePair<String,BitmapTypedValue>>

IEnumerable<KeyValuePair<String,BitmapTypedValue>>

IIterable<IKeyValuePair<Platform::String,BitmapTypedValue>>

IIterable<IKeyValuePair<winrt::hstring,BitmapTypedValue>>

The specified encoding options. A collection of key-value pairs containing one or more codec-specific encoding options and the desired values.

Returns

IAsyncAction

An object that manages the asynchronous operation of committing the current frame data and appending a new empty frame to be edited.

Attributes
OverloadAttribute RemoteAsyncAttribute

Remarks

You can obtain a collection of key-value pairs that you can pass to the encodingOptions parameter by creating a new BitmapPropertySet.

See CreateAsync(Guid, IRandomAccessStream, IIterable(IKeyValuePair)) for more information about using encoding options.

See also

Applies to