DeviceThumbnail DeviceThumbnail DeviceThumbnail Class

Definition

Represents the thumbnail image for a device.

public sealed class DeviceThumbnail : IClosable, IContentTypeProvider, IInputStream, IOutputStream, IRandomAccessStream, IRandomAccessStreamWithContentTypepublic sealed class DeviceThumbnail : IDisposable, IContentTypeProvider, IInputStream, IOutputStream, IRandomAccessStream, IRandomAccessStreamWithContentTypePublic NotInheritable Class DeviceThumbnail Implements IDisposable, IContentTypeProvider, IInputStream, IOutputStream, IRandomAccessStream, IRandomAccessStreamWithContentType
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Call DeviceInformation.GetThumbnailAsync and handle the completion event as shown in the example.

Examples

// Takes a parameter of type DeviceInformation
// and retrieves a DeviceThumbnail to pass to displayImage().
function getImage (device) {   

    var thumbnail = null;
    if (device){
        device.getThumbnailAsync().then(
            function (thumbnail) {
                if (thumbnail){      
                    if (thumbnail.size > 0) {
                        displayImage(thumbnail);
                    }                                                                      
                 }     
             });
    }                                                                                     
}

function displayImage(imageFile) {

    try {
        // Setting 2nd parameter to 'false' cleans up 
        // the URL after first use.
        // We set this because we only need to load the URL
        // into the image tag once.
        document.getElementById("deviceImage").src = 
            window.URL.createObjectURL(imageFile, false);
    } catch (e) {
        document.getElementById("statusMessage").innerHTML = 
            "Could not display image, error: " + e.message;
    }

}

Properties

CanRead CanRead CanRead

Gets a value that indicates whether the stream can be read from.

public bool CanRead { get; }public bool CanRead { get; }Public ReadOnly Property CanRead As bool
Value
bool bool bool

True if the stream can be read from. Otherwise, false.

Attributes

CanWrite CanWrite CanWrite

Gets a value that indicates whether the stream can be written to.

public bool CanWrite { get; }public bool CanWrite { get; }Public ReadOnly Property CanWrite As bool
Value
bool bool bool

True if the stream can be written to. Otherwise, false.

Attributes

ContentType ContentType ContentType

Returns the content type of the thumbnail image.

public string ContentType { get; }public string ContentType { get; }Public ReadOnly Property ContentType As string
Value
string string string

The content type of the image.

Attributes

Position Position Position

Gets the byte offset of the stream.

public ulong Position { get; }public ulong Position { get; }Public ReadOnly Property Position As ulong
Value
ulong ulong ulong

The number of bytes from the start of the stream.

Attributes

Size Size Size

Gets or sets the size of the device thumbnail image.

public ulong Size { get; set; }public ulong Size { get; set; }Public ReadWrite Property Size As ulong
Value
ulong ulong ulong

The size of the device thumbnail image.

Attributes

Methods

CloneStream() CloneStream() CloneStream()

Creates a new instance of a IRandomAccessStream over the same resource as the current stream.

public IRandomAccessStream CloneStream()public IRandomAccessStream CloneStream()Public Function CloneStream() As IRandomAccessStream
Returns

The new stream. The initial, internal position of the stream is 0.

Attributes

Close() Close() Close()

Closes the current stream and releases system resources.

public void Close()This member is not implemented in C#This member is not implemented in VB.Net
Attributes

Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

This member is not implemented in C++void Dispose()Sub Dispose
Attributes

FlushAsync() FlushAsync() FlushAsync()

Flushes data asynchronously in a sequential stream.

public IAsyncOperation<bool> FlushAsync()public IAsyncOperation<bool> FlushAsync()Public Function FlushAsync() As IAsyncOperation( Of bool )
Returns

The stream flush operation.

Attributes

GetInputStreamAt(UInt64) GetInputStreamAt(UInt64) GetInputStreamAt(UInt64)

Returns a pointer to an input stream starting at the specified location.

public IInputStream GetInputStreamAt(UInt64 position)public IInputStream GetInputStreamAt(UInt64 position)Public Function GetInputStreamAt(position As UInt64) As IInputStream
Parameters
position
System.UInt64 System.UInt64 System.UInt64

The position in the input stream.

Returns

A pointer to an input stream.

Attributes

GetOutputStreamAt(UInt64) GetOutputStreamAt(UInt64) GetOutputStreamAt(UInt64)

Returns a pointer to an output stream starting at the specified location.

public IOutputStream GetOutputStreamAt(UInt64 position)public IOutputStream GetOutputStreamAt(UInt64 position)Public Function GetOutputStreamAt(position As UInt64) As IOutputStream
Parameters
position
System.UInt64 System.UInt64 System.UInt64

The position in the output stream.

Returns

A pointer to an output stream.

Attributes

ReadAsync(IBuffer, UInt32, InputStreamOptions) ReadAsync(IBuffer, UInt32, InputStreamOptions) ReadAsync(IBuffer, UInt32, InputStreamOptions)

Returns an asynchronous byte reader object.

public IAsyncOperationWithProgress<IBuffer, uint> ReadAsync(IBuffer buffer, UInt32 count, InputStreamOptions options)public IAsyncOperationWithProgress<IBuffer, uint> ReadAsync(IBuffer buffer, UInt32 count, InputStreamOptions options)Public Function ReadAsync(buffer As IBuffer, count As UInt32, options As InputStreamOptions) As IAsyncOperationWithProgress( Of IBuffer, uint )
Parameters
buffer
IBuffer IBuffer IBuffer

The buffer into which the asynchronous read operation places the bytes that are read.

count
System.UInt32 System.UInt32 System.UInt32

The number of bytes to read.

options
InputStreamOptions InputStreamOptions InputStreamOptions

Specifies the type of the asynchronous read operation.

Returns

The asynchronous operation.

Attributes

Seek(UInt64) Seek(UInt64) Seek(UInt64)

Sets the position of the stream to the specified value.

public void Seek(UInt64 position)public void Seek(UInt64 position)Public Function Seek(position As UInt64) As void
Parameters
position
System.UInt64 System.UInt64 System.UInt64

The new position of the stream.

Attributes

WriteAsync(IBuffer) WriteAsync(IBuffer) WriteAsync(IBuffer)

Writes data asynchronously in a sequential stream.

public IAsyncOperationWithProgress<uint, uint> WriteAsync(IBuffer buffer)public IAsyncOperationWithProgress<uint, uint> WriteAsync(IBuffer buffer)Public Function WriteAsync(buffer As IBuffer) As IAsyncOperationWithProgress( Of uint, uint )
Parameters
buffer
IBuffer IBuffer IBuffer

The buffer into which the asynchronous writer operation writes.

Returns

The byte writer operation.

Attributes