StorageFile.GetThumbnailAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) |
サムネイルの目的、要求されたサイズ、および指定したオプションによって決定される、ファイルの調整されたサムネイル画像を取得します。 |
GetThumbnailAsync(ThumbnailMode) |
サムネイルの目的によって決まる、ファイルの調整済みのサムネイル画像を取得します。 |
GetThumbnailAsync(ThumbnailMode, UInt32) |
サムネイルの目的と要求されたサイズによって決まる、ファイルの調整済みのサムネイル画像を取得します。 |
GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)
サムネイルの目的、要求されたサイズ、および指定したオプションによって決定される、ファイルの調整されたサムネイル画像を取得します。
public:
virtual IAsyncOperation<StorageItemThumbnail ^> ^ GetThumbnailAsync(ThumbnailMode mode, unsigned int requestedSize, ThumbnailOptions options) = GetThumbnailAsync;
/// [Windows.Foundation.Metadata.Overload("GetThumbnailAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode const& mode, uint32_t const& requestedSize, ThumbnailOptions const& options);
[Windows.Foundation.Metadata.Overload("GetThumbnailAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, uint requestedSize, ThumbnailOptions options);
function getThumbnailAsync(mode, requestedSize, options)
Public Function GetThumbnailAsync (mode As ThumbnailMode, requestedSize As UInteger, options As ThumbnailOptions) As IAsyncOperation(Of StorageItemThumbnail)
パラメーター
- mode
- ThumbnailMode
サムネイルの目的を説明し、サムネイルイメージの調整方法を決定する列挙値。
最適なサムネイル モードの選択に関するガイダンスについては、「サムネイル のガイドラインとチェックリスト」を参照してください。
- requestedSize
-
UInt32
unsigned int
uint32_t
サムネイルの最も長い端の要求されたサイズ (ピクセル単位)。 Windows では 、requestedSize をガイドとして使用し、画像の品質を低下させることなくサムネイルイメージのスケーリングを試みます。
Windows で、要求されたサイズに合わせてスケーリングできるサムネイル画像が見つからない場合は、大きなサムネイルが返される可能性があります。 大きなサムネイルが使用できない場合は、要求されたサイズよりも小さいサムネイル画像が返される可能性があります。
- options
- ThumbnailOptions
サムネイル 画像を取得するために使用する必要な動作を表す列挙値。 指定した動作は、画像のサイズや品質、およびサムネイル画像の取得速度に影響を与える可能性があります。
戻り値
このメソッドが正常に完了すると、サムネイル画像を表す StorageItemThumbnail が返されます。ファイルに関連付けられているサムネイル イメージがない場合は null を 返します。
実装
- 属性
例
この例では、[storageFile.getThumbnailAsync(mode, requestedSize, options) メソッドを使用してファイルのサムネイルをキャプチャする方法を示します。
storageFile.getThumbnailAsync(
Windows.Storage.FileProperties.ThumbnailMode.musicView,
100,
Windows.Storage.FileProperties.ThumbnailOptions.useCurrentScale).then(
function (storageItemThumbnail) {
// Add code to process thumbnail
}
);
StorageFile.GetThumbnailAsync メソッドのいずれかを使用するには、ファイルを表す StorageFile オブジェクト (storageFile
例では) が必要です。
注釈
GetThumbnailAsync はサムネイル ディスク キャッシュでサポートされている最大サイズに準拠していますが、GetScaledImageAsThumbnailAsync はサムネイル ディスク キャッシュでサポートされているサイズよりも大きいサムネイルを抽出できます。 GetScaledImageAsThumbnailAsync は最適な品質を提供しますが、サムネイル サイズが大きすぎる場合はディスク キャッシュを使用しないことでパフォーマンスに影響を与える可能性があります。
こちらもご覧ください
- GetScaledImageAsThumbnailAsync(ThumbnailMode)
- GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32)
- GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)
- GetThumbnailAsync(ThumbnailMode)
- GetThumbnailAsync(ThumbnailMode, UInt32)
- ThumbnailOptions
適用対象
GetThumbnailAsync(ThumbnailMode)
サムネイルの目的によって決まる、ファイルの調整済みのサムネイル画像を取得します。
public:
virtual IAsyncOperation<StorageItemThumbnail ^> ^ GetThumbnailAsync(ThumbnailMode mode) = GetThumbnailAsync;
/// [Windows.Foundation.Metadata.Overload("GetThumbnailAsyncOverloadDefaultSizeDefaultOptions")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode const& mode);
[Windows.Foundation.Metadata.Overload("GetThumbnailAsyncOverloadDefaultSizeDefaultOptions")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode);
function getThumbnailAsync(mode)
Public Function GetThumbnailAsync (mode As ThumbnailMode) As IAsyncOperation(Of StorageItemThumbnail)
パラメーター
- mode
- ThumbnailMode
サムネイルの目的を説明し、サムネイルイメージの調整方法を決定する列挙値。
最適なサムネイル モードの選択に関するガイダンスについては、「サムネイル のガイドラインとチェックリスト」を参照してください。
戻り値
このメソッドが正常に完了すると、サムネイル画像を表す StorageItemThumbnail が返されます。ファイルに関連付けられているサムネイル イメージがない場合は null を 返します。
実装
- 属性
注釈
GetThumbnailAsync はサムネイル ディスク キャッシュでサポートされている最大サイズに準拠していますが、GetScaledImageAsThumbnailAsync はサムネイル ディスク キャッシュでサポートされているサイズよりも大きいサムネイルを抽出できます。 GetScaledImageAsThumbnailAsync は最適な品質を提供しますが、サムネイル サイズが大きすぎる場合はディスク キャッシュを使用しないことでパフォーマンスに影響を与える可能性があります。
こちらもご覧ください
- GetScaledImageAsThumbnailAsync(ThumbnailMode)
- GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32)
- GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)
- GetThumbnailAsync(ThumbnailMode, UInt32)
- GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)
- ThumbnailMode
適用対象
GetThumbnailAsync(ThumbnailMode, UInt32)
サムネイルの目的と要求されたサイズによって決まる、ファイルの調整済みのサムネイル画像を取得します。
public:
virtual IAsyncOperation<StorageItemThumbnail ^> ^ GetThumbnailAsync(ThumbnailMode mode, unsigned int requestedSize) = GetThumbnailAsync;
/// [Windows.Foundation.Metadata.Overload("GetThumbnailAsyncOverloadDefaultOptions")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode const& mode, uint32_t const& requestedSize);
[Windows.Foundation.Metadata.Overload("GetThumbnailAsyncOverloadDefaultOptions")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, uint requestedSize);
function getThumbnailAsync(mode, requestedSize)
Public Function GetThumbnailAsync (mode As ThumbnailMode, requestedSize As UInteger) As IAsyncOperation(Of StorageItemThumbnail)
パラメーター
- mode
- ThumbnailMode
サムネイルの目的を説明し、サムネイルイメージの調整方法を決定する列挙値。
最適なサムネイル モードの選択に関するガイダンスについては、「サムネイル のガイドラインとチェックリスト」を参照してください。
- requestedSize
-
UInt32
unsigned int
uint32_t
サムネイルの最も長い端の要求されたサイズ (ピクセル単位)。 Windows では 、requestedSize をガイドとして使用し、画像の品質を低下させることなくサムネイルイメージのスケーリングを試みます。
Windows で、要求されたサイズに合わせてスケーリングできるサムネイル画像が見つからない場合は、大きなサムネイルが返される可能性があります。 大きなサムネイルが使用できない場合は、要求されたサイズよりも小さいサムネイル画像が返される可能性があります。
戻り値
このメソッドが正常に完了すると、サムネイル画像を表す StorageItemThumbnail が返されます。ファイルに関連付けられているサムネイル イメージがない場合は null を 返します。
実装
- 属性
注釈
GetThumbnailAsync はサムネイル ディスク キャッシュでサポートされている最大サイズに準拠していますが、GetScaledImageAsThumbnailAsync はサムネイル ディスク キャッシュでサポートされているサイズよりも大きいサムネイルを抽出できます。 GetScaledImageAsThumbnailAsync は最適な品質を提供しますが、サムネイル サイズが大きすぎる場合はディスク キャッシュを使用しないことでパフォーマンスに影響を与える可能性があります。
こちらもご覧ください
- GetScaledImageAsThumbnailAsync(ThumbnailMode)
- GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32)
- GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)
- GetThumbnailAsync(ThumbnailMode)
- GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)