プレイヤーオプション照会
    • PDF

    プレイヤーオプション照会

    • PDF

    記事の要約

    プレイヤーに設定された情報を照会する方法は、次の通りです。

    リクエスト

    GET {API_URL}/players/{player_no}/options
    

    リクエストパラメータ

    フィールド名要否タイプ制約事項説明
    player_noYIntegerPath Parameterプレイヤー番号

    レスポンス

    フィールド名タイプ説明備考
    resultObject
    result.envString環境
    result.optionsString(json)設定されたオプション

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

    フィールド名要否タイプ制限説明
    player_noYIntegerプレイヤー番号
    optionYObject(json)プレイヤーオプション情報
    option.aspectRatioNString無料/有料アスペクト比、デフォルト値 16/9、
    オプション: 16/9、4/3、1/1、9/16、21/9
    option.autoPauseNBoolean無料/有料無効化時に再生を自動停止
    option.autostartNBoolean無料/有料自動再生有無、デフォルト値 TRUE
    option.repeatNBoolean無料/有料動画繰り返し、デフォルト値 FALSE
    option.langNString無料/有料UI言語設定、デフォルト値: auto
    オプション: auto、ko、en、ja
    option.mutedNBoolean無料/有料ミュート、デフォルト値 FALSE
    option.objectFitNString無料/有料アスペクト比設定、デフォルト値 contain、
    オプション: contain、cover、fill
    option.controlActiveTimeNInteger無料/有料コントロールバーの有効時間(ms)
    デフォルト値 3000
    option.controlsNBoolean無料/有料コントロールバー使用有無、デフォルト値 TRUE
    option.controlBtnNObject有料コントロールバーボタンの表示有無設定、有料のみ変更可能
    option.controlBtn.fullscreenNBoolean有料全体画面、有料のみ変更可能、デフォルト値 TRUE
    option.controlBtn.pictureInPictureNBoolean有料ミニプレイヤー、有料のみ変更可能、デフォルト値 TRUE
    option.controlBtn.playNBoolean有料プレイボタン表示、有料のみ変更可能、デフォルト値 TRUE
    option.controlBtn.timesNBoolean有料時間表示、有料のみ変更可能、デフォルト値 TRUE
    option.controlBtn.volumeNBoolean有料ボリューム調整、有料のみ変更可能、デフォルト値 TRUE
    option.controlBtn.settingNBoolean有料設定ボタン表示、有料のみ変更可能、デフォルト値 TRUE
    option.descriptionNotVisibleNBoolean有料動画メタデータ UI非表示、有料のみメタデータ設定可能、デフォルト値 FALSE
    option.playRateSettingNArray有料倍速選択オプション
    有料のみ変更可能、デフォルトオプション値: [0.5、0.75、1、1.5、2]
    option.progressBarColorNString有料コントロールバーのカラー、有料のみ変更可能
    デフォルト値: #4299f5
    option.seekingPreviewNBoolean有料動画区間移動のプレビュー、デフォルト値 TRUE
    option.setStartTimeNString有料初公開日
    option.startMutedInfoNotVisibleNBoolean有料ミュート通知、デフォルト値 FALSE
    option.keyboardShortcutNBoolean有料キーボードショートカット有無、デフォルト値 TRUE
    option.touchGesturesNBoolean有料タッチジェスチャの有効化
    option.uiNString有料UI設定、デフォルト値 all
    有料のみオプション設定可能: all、mobile、pc
    option.lowLatencyModeNBoolean有料LL-HLS超遅延モード対応、LIVE映像を常に最新区間に維持
    デフォルト値: FALSE
    option.customBtnsNArray有料カスタムボタン追加(最大4個)
    option.customBtns.uiYString有料カスタムボタンのデバイス環境 UI(PC、MOBILE)
    option.customBtns.positionYString有料カスタムボタンの位置設定(left-top、left-bottom、right-top、right-bottom
    option.customBtns.flowNString有料カスタムボタンの作成位置設定(left、right、デフォルト: left)
    option.customBtns.iconYString有料カスタムボタンの画像 URL設定

    リクエスト例

    GET /api/v1/players/option?player_no=1
    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
    

    成功コード

    HttpStatusCodeCodeMessage
    200200ok

    エラーコード

    HttpStatusCodeCodeMessageDescription
    2004601Query string player_no is missing.
    2004801No player information.

    レスポンス例

    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": "string",
      "message": "string",
      "result": {
        "env": "string",
        "option": {
          "aspectRatio": "string",
          "autoPause": true,
          "autostart": true,
          "controlActiveTime": 0,
          "controlBtn": {
            "fullscreen": true,
            "pictureInPicture": true,
            "play": true,
            "setting": true,
            "times": true,
            "volume": true
          },
          "controls": true,
          "descriptionNotVisible": true,
          "keyboardShortcut": true,
          "muted": true,
          "objectFit": "string",
          "playRateSetting": [
            0
          ],
          "progressBarColor": "string",
          "repeat": true,
          "seekingPreview": true,
          "startMutedInfoNotVisible": true,
          "touchGestures": true,
          "ui": "string"
        }
      }
    }
    
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.