このトピックでは、WVScreen の JavaScript API について説明します。 HTML5 アプリまたはミニアプリを作成する際に、このトピックを参照できます。 WVScreen の JavaScript API は、現在のアクティビティまたはビューコントローラーの表示方向(横向きまたは縦向き)を設定および取得する機能と、画面の輝度を設定および取得する機能を提供します。
WVScreen.getOrientation
現在のアクティビティまたはビューコントローラーの表示方向(横向きまたは縦向き)を取得します。
入力パラメーター
入力パラメーターはありません。
コールバックパラメーター
コールバックパラメーターはコールバックメソッドに渡されます。表示方向が取得された場合は、success
コールバックが呼び出されます。それ以外の場合は、failure
コールバックが呼び出されます。
[
string
]orientation: 現在のアクティビティまたはビューコントローラーの表示方向。有効な値:'landscape'
'portrait'
'unknown'
window.WindVane.call('WVScreen', 'getOrientation', {}, function(e) {
alert('success: ' + JSON.stringify(e));
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});
WVScreen.setOrientation
現在のアクティビティまたはビューコントローラーの表示方向(横向きまたは縦向き)を設定します。 WVScreen は、WebView がリダイレクトするページの表示方向にも影響することに注意してください。そのため、WebView がページにリダイレクトするたびに、表示方向を復元する必要があります。
入力パラメーター
[
string
]orientation: アクティビティの表示方向。有効な値:'default'
: クライアントのデフォルトの表示方向。'landscape'
: 横長の表示方向。デバイスの持ち方に基づいて、表示方向は左横向きまたは右横向きモードに自動的に切り替わります。この自動切り替えは、一部のクライアントではサポートされていない場合があります。'portrait'
: 縦長の表示方向。'landscapeRight'
: 右横向き。画面が反時計回りに 90 度回転します。'landscapeLeft'
: 左横向き。画面が時計回りに 90 度回転します。'portraitUpsideDown'
: 反転した縦向き。'auto'
: 表示方向を自動的に切り替えるように指定します。
コールバックパラメーター
コールバックパラメーターはありません。表示方向が設定された場合は、success
コールバックが呼び出されます。それ以外の場合は、failure
コールバックが呼び出されます。
var params = {
orientation: 'landscape'
};
window.WindVane.call('WVScreen', 'setOrientation', params, function(e) {
alert('success: ' + JSON.stringify(e));
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});
WVScreen.setScreenBrightness
この API は、WindVane Android 1.0.3.4 以降、WindVane iOS 2.1.4 以降でのみ使用できます。
画面の輝度を設定します。
入力パラメーター
[
number
]brightness: 画面の輝度。有効な値:0 ~ 255。
コールバックパラメーター
成功コールバックのパラメーター:
コールバックパラメーターはありません。
失敗コールバックのパラメーター:
[
string
]msg: エラーメッセージ。
var params = {
brightness: '100'
};
window.WindVane.call('WVScreen', 'setScreenBrightness', params, function(e) {
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});
WVScreen.getScreenBrightness
この API は、WindVane Android 1.0.3.4 以降、WindVane iOS 2.1.4 以降でのみ使用できます。
画面の輝度を取得します。
入力パラメーター
入力パラメーターはありません。
コールバックパラメーター
[
string
]brightness: 画面の輝度。
window.WindVane.call('WVScreen', 'getScreenBrightness', {}, function(e) {
alert('success: ' + JSON.stringify(e));
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});