リクエスト

PUT {API_URL}/players/{player_no}/applyDev

プレイヤーオプション情報

フィールド名	必須の有無	タイプ	制限	説明
player_no	Y	Integer	Path Parameter	プレイヤー番号
option	Y	Object(json)		プレイヤーオプション情報
option.aspectRatio	N	String	無料/有料	画面アスペクト比、デフォルトは16/9、オプション: 16/9、4/3、1/1、9/16、21/9
option.autoPause	N	Boolean	無料/有料	無効化すると再生は自動で止まる
option.autostart	N	Boolean	無料/有料	自動再生かどうか、デフォルト: TRUE
option.repeat	N	Boolean	無料/有料	リピート再生、デフォルト: FALSE
option.lang	N	String	無料/有料	UI言語設定、デフォルト: auto オプション: auto、ko、en、ja
option.muted	N	Boolean	無料/有料	ミュート、デフォルト: FALSE
option.objectFit	N	String	無料/有料	映像のアスペクト比をモニターに合わせる、デフォルト: contain、オプション: contain、cover、fill
option.controlActiveTime	N	Integer	無料/有料	コントロールバー有効化時間(ms) デフォルト: 3000
option.controls	N	Boolean	無料/有料	コントロールバーの使用有無、デフォルト: TRUE
option.controlBtn	N	Object	有料	コントロールバーボタンの表示有無を設定、有料のみ変更可能
option.controlBtn.fullscreen	N	Boolean	有料	全画面、有料のみ変更可能、デフォルト: TRUE
option.controlBtn.pictureInPicture	N	Boolean	有料	ミニプレイヤー、有料のみ変更可能、デフォルト: TRUE
option.controlBtn.play	N	Boolean	有料	プレイボタンを表示、有料のみ変更可能、デフォルト: TRUE
option.controlBtn.times	N	Boolean	有料	時間表示、有料のみ変更可能、デフォルト: TRUE
option.controlBtn.volume	N	Boolean	有料	ボリューム調整、有料のみ変更可能、デフォルト: TRUE
option.controlBtn.subtitle	N	Boolean	有料	字幕制御ボタンを表示、有料のみ変更可能、デフォルト: TRUE
option.controlBtn.setting	N	Boolean	有料	設定ボタンを表示、有料のみ変更可能、デフォルト: TRUE
option.controlBtn.progressBar	N	Boolean	有料	再生バーの使用有無、デフォルト: TRUE
option.descriptionNotVisible	N	Boolean	有料	映像メタデータ UIを非表示にする、有料のみメタデータを設定可能、デフォルトは FALSE
option.playRateSetting	N	Array	有料	倍速選択オプション有料のみ変更可能、デフォルト: [0.5、0.75、1、1.5、2]
option.progressBarColor	N	String	有料	コントロールバーカラー、有料のみ変更可能デフォルト: #4299f5
option.seekingPreview	N	Boolean	有料	映像区間移動時のプレビュー、デフォルト: TRUE
option.startMutedInfoNotVisible	N	Boolean	有料	ミュートの通知、デフォルト: FALSE
option.keyboardShortcut	N	Boolean	有料	キーボードショートカットキーの有無、デフォルト: TRUE
option.touchGestures	N	Boolean	有料	タッチジェスチャーを有効化
option.ui	N	String	有料	UI設定、デフォルトは all 有料のみオプション設定可能: all、mobile、pc
option.lowLatencyMode	N	Boolean	有料	LL-HLS超低遅延モードに対応、LIVE映像を常に最新区間に維持デフォルト: FALSE
option.customBtns	N	Array	有料	カスタムボタンを追加(最大4個)
option.customBtns.ui	Y	String	有料	カスタムボタンのデバイス環境 UI (PC、MOBILE)
option.customBtns.position	Y	String	有料	カスタムボタンの位置を設定(left-top、left-bottom、right-top、right-bottom)
option.customBtns.flow	N	String	有料	カスタムボタン作成位置を設定(left、right、デフォルト: left)
option.customBtns.icon	Y	String	有料	カスタムボタン画像 URLを設定

リクエスト例

PUT /api/v1/players/1/applyDev
HOST: vpe.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1521787414578
x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy
x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=
x-ncp-region_code:KR

Request body
{
  "option": {
    "aspectRatio": "string",
    "autoPause": true,
    "autostart": true,
    "controlActiveTime": 0,
    "controlBtn": {
      "fullscreen": true,
      "pictureInPicture": true,
      "play": true,
      "setting": true,
      "times": true,
      "volume": true,
      "subtitle": true,
      "progressBar": true
    },
    "controls": true,
    "descriptionNotVisible": true,
    "keyboardShortcut": true,
    "lang": "auto",
    "lowLatencyMode": true,
    "muted": true,
    "objectFit": "string",
    "playRateSetting": [
      0
    ],
    "progressBarColor": "string",
    "repeat": true,
    "seekingPreview": true,
    "startMutedInfoNotVisible": true,
    "touchGestures": true,
    "ui": "string",
    "visibleWatermark": true
  }
}

成功コード

HttpStatusCode	Code	Message
200	200	ok

エラーコード

HttpStatusCode	Code	Message
200	4601	Query string player_no is missing.
200	4729	Body (JSON) customBtns must be array.
200	4730	Body (JSON) customBtns is up to 4.
200	4731	Body (JSON) customBtns position is invalid.
200	4732	Body (JSON) customBtns position is required.
200	4733	Body (JSON) customBtns icon is required.
200	4734	Body (JSON) customBtns ui is required.
200	4735	Body (JSON) customBtns ui is invalid.
200	4736	Body (JSON) customBtns flow is invalid.
200	4706	Enter an option value for Body (JSON).
200	4801	No player information.
200	4804	The feature can't be used in the free version of player.

レスポンス例

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 26 Feb 2021 09:53:32 GMT
Content-Type: application/json;charset=utf-8
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4

// 成功時
{
  "code": "200",
  "message": "ok"
}

// 失敗時
"error": {
    "errorCode": "4804",
    "message": "The feature can't be used in the free version of player. "
  }
}

この記事は役に立ちましたか?

リクエスト