GoToNextFrameAsync() | goToNextFrameAsync() method
Collapse the table of content
Expand the table of content

BitmapEncoder.GoToNextFrameAsync() | goToNextFrameAsync() method

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

Syntax


bitmapEncoder.goToNextFrameAsync().done( /* Your success and error handlers */ );

Parameters

This method has no parameters.

Return value

Type: IAsyncAction

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

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.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Graphics.Imaging
Windows::Graphics::Imaging [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Graphics.Imaging
Windows::Graphics::Imaging [C++]

Metadata

Windows.winmd

See also

BitmapEncoder
GoToNextFrameAsync(IIterable(IKeyValuePair))

 

 

Show:
© 2016 Microsoft