ホーム › Media.MediaPlayer › IWMPSubscriptionService2

IWMPSubscriptionService2

COM

📘 Microsoft Learn (日本語) · English

IIDa94c120e-d600-4ec6-b05e-ec9d56d84de0継承元IWMPSubscriptionService自前メソッド開始 vtbl7

公式ドキュメント

メモこのセクションでは、オンラインストアでの使用を想定した機能について説明します。

メソッド 4

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 7 HRESULT stopBackgroundProcessing()

メモこのセクションでは、オンラインストアでの使用を想定した機能について説明します。

戻り値

このメソッドは HRESULT を返します。指定できる値には、以下の表に示すものが含まれますが、これらに限定されません。

戻り値のコード	説明
S_OK	メソッドは成功しました。

解説(Remarks)

stopBackgroundProcessing の呼び出しは startBackgroundProcessing の呼び出しの後に行われ、バックグラウンド処理タスクを中断する必要があることをオンラインストアに通知します。

vtbl 8 HRESULT serviceEvent(WMPSubscriptionServiceEvent event)

メモこのセクションでは、オンラインストアでの使用を想定した機能について説明します。オンラインストア以外のコンテキストでこの機能を使用することはサポートされていません。serviceEvent メソッドは、オンラインストアがアクティブ化または非アクティブ化されたときに呼び出されます。

event

WMPSubscriptionServiceEvent

サービスがアクティブ化されたか非アクティブ化されたかを示す WMPSubscriptionServiceEvent 列挙値。

戻り値

このメソッドは HRESULT を返します。指定できる値には、以下の表に示すものが含まれますが、これらに限定されません。

戻り値のコード	説明
S_OK	メソッドは成功しました。

解説(Remarks)

Windows Media Player がこのメソッドを呼び出すとき、コードで時間のかかる処理を同期的に実行しないでください。代わりに、時間のかかるタスクは別のワーカースレッドで実行する必要があります。

vtbl 9 HRESULT deviceAvailable(LPWSTR bstrDeviceName, IWMPSubscriptionServiceCallback* pCB)

メモこのセクションでは、オンラインストアでの使用を想定した機能について説明します。

bstrDeviceName	LPWSTR	in	デバイス名を含む文字列。
pCB	IWMPSubscriptionServiceCallback*	in	IWMPSubscriptionServiceCallback インターフェースへのポインター。オンラインストアはこのポインターを使用して、デバイス固有の処理が完了したことを Windows Media Player に通知します。

戻り値

このメソッドは HRESULT を返します。指定できる値には、以下の表に示すものが含まれますが、これらに限定されません。

戻り値のコード	説明
S_OK	メソッドは成功しました。

解説(Remarks)

前回の呼び出しからの経過時間が 1 週間以上の場合、Windows Media Player は同期操作の後にこのメソッドを呼び出します。

Windows Media Player がこのメソッドを呼び出すとき、コードで時間のかかる処理を同期的に実行しないでください。代わりに、時間のかかるタスクは別のワーカースレッドで実行する必要があります。ワーカースレッドが処理を完了したら、IWMPSubscriptionServiceCallback::onComplete を呼び出す必要があります。

ワーカースレッドに IWMPSubscriptionServiceCallback インターフェースへのポインターを渡すには、次の手順を使用します。

pCB を CoMarshalInterThreadInterfaceInStream に渡すと、IStream ポインターが返されます。
IStream ポインターをワーカースレッドに渡します。
ワーカースレッドで CoGetInterfaceAndReleaseStream を呼び出すと、onComplete の呼び出しに使用できるインターフェースポインターが返されます。

bstrDeviceName に含まれる文字列は、IWMPSyncDevice::get_deviceName を使用して取得される名前とは異なります。これは、Windows Media Device Manager SDK が提供する IWMDMDevice2::GetCanonicalName メソッドを使用して取得される正規名です。

vtbl 10 HRESULT prepareForSync(LPWSTR bstrFilename, LPWSTR bstrDeviceName, IWMPSubscriptionServiceCallback* pCB)

メモこのセクションでは、オンラインストアでの使用を想定した機能について説明します。

bstrFilename	LPWSTR	in	同期対象のデジタルメディアファイルの名前を含む文字列。
bstrDeviceName	LPWSTR	in	デバイスの正規名を含む文字列。
pCB	IWMPSubscriptionServiceCallback*	in	IWMPSubscriptionServiceCallback インターフェースへのポインター。オンラインストアはこのポインターを使用して、同期の準備が完了したことを Windows Media Player に通知します。

戻り値

このメソッドは HRESULT を返します。指定できる値には、以下の表に示すものが含まれますが、これらに限定されません。

戻り値のコード	説明
S_OK	メソッドは成功しました。

解説(Remarks)

ワーカースレッドに IWMPSubscriptionServiceCallback インターフェースへのポインターを渡すには、次の手順を使用します。

pCB を CoMarshalInterThreadInterfaceInStream に渡すと、IStream ポインターが返されます。
IStream ポインターをワーカースレッドに渡します。
ワーカースレッドで CoGetInterfaceAndReleaseStream を呼び出すと、onComplete の呼び出しに使用できるインターフェースポインターが返されます。

IWMPSubscriptionServiceCallback::onComplete を呼び出すときは、指定されたデジタルメディアファイルの同期を Windows Media Player が続行できるようにするには成功コードを返し、同期を禁止するにはエラーコードを返す必要があります。Windows Media Player は、指定されたエラーコードに基づいてエラーメッセージを表示します。E_FAIL などの汎用的な HRESULT の使用は避けてください。代わりに、Windows Media Device Manager SDK などの Windows Media SDK のいずれかの呼び出しから受け取る HRESULT エラーコード、または Windows Media Player SDK をインストールした場所の \Include フォルダーにある nserror.h のエラーコードのいずれかを返すことができます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

#define global IID_IWMPSubscriptionService2 "{A94C120E-D600-4EC6-B05E-EC9D56D84DE0}"
#usecom global IWMPSubscriptionService2 IID_IWMPSubscriptionService2 "{}"
#comfunc global IWMPSubscriptionService2_stopBackgroundProcessing  7
#comfunc global IWMPSubscriptionService2_serviceEvent              8 int
#comfunc global IWMPSubscriptionService2_deviceAvailable           9 wstr,sptr
#comfunc global IWMPSubscriptionService2_prepareForSync            10 wstr,wstr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。