このトピックでは、HTML5 アプリまたはミニアプリにスクリーンショット機能を追加するための WVScreenCapture JS API について説明します。
WVScreenCapture.capture
この API は、Android 版 Windvane 1.0.3.4 以降でのみ利用可能です。
Android 版 Windvane 1.0.3.3 以前の場合は、
WVScreen.captureを使用してください。入力パラメーターとコールバックパラメーターはWVScreenCapture.captureと同じです。
WebView の現在のコンテンツをイメージとしてキャプチャします。
iOS 11 以降では、アプリがフォトアルバムにアクセスするための権限が必要です。これを有効にするには、NSPhotoLibraryAddUsageDescription キーを Info.plist ファイルに追加し、対応する使用状況の説明を提供する必要があります。
入力パラメーター
[
String]inAlbum: スクリーンショットをフォトアルバムに保存するかどうかを決定します。保存する場合は'true'に、保存しない場合は'false'に設定します。デフォルトは'false'です。[
String]type: スクリーンショットのタイプです。WebView のコンテンツのみをキャプチャする場合は'view'に、アプリのウィンドウ全体をキャプチャする場合は'app'に設定します。デフォルトは'view'です。'app'に設定すると、スクリーンショットにはステータスバーのバックグラウンドが含まれますが、そのテキストは含まれません。SmartBar などのソフトキーボードを備えた一部の Android デバイスでは、キーボードのエリアが黒い長方形としてキャプチャされます。
コールバックパラメーター
キャプチャが成功した場合、結果とともに success コールバックが呼び出されます。失敗した場合は、failure コールバックが呼び出されます。
[
string]url: キャプチャされたイメージの URL です。この URL をimg要素のsrc属性に割り当てることで、プレビューできます。説明これはパブリック CDN URL ではないため、ブラウザではアクセスできません。
[
string]localPath: スクリーンショットファイルのローカルパスです。このパスをWVCamera.confirmUploadPhotoなどの他の API で使用して、ファイルを CDN にアップロードします。
var params = {
// スクリーンショットをフォトアルバムに保存します。
inAlbum: 'true'
};
window.WindVane.call('WVScreenCapture', 'capture', params, function(e) {
alert('success: ' + JSON.stringify(e));
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});