プレイヤーオプションを develop環境にデプロイ
    • PDF

    プレイヤーオプションを develop環境にデプロイ

    • PDF

    記事の要約

    設定したプレイヤーオプションを development環境にデプロイする方法は次の通りです。

    リクエスト

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

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

    フィールド名必須の有無タイプ制限説明
    player_noYIntegerPath Parameterプレイヤー番号
    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.subtitleNBoolean有料字幕コントロールボタンの表示、有料のみ変更可能、デフォルトは 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.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を設定

    リクエスト例

    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
        },
        "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
      }
    }
    
    

    成功コード

    HttpStatusCodeCodeMessage
    200200ok

    エラーコード

    HttpStatusCodeCodeMessageDescription
    2004601Query string player_no is missing.
    2004729Body (JSON) customBtns must be array.
    2004730Body (JSON) customBtns is up to 4.
    2004731Body (JSON) customBtns position is invalid.
    2004732Body (JSON) customBtns position is required.
    2004733Body (JSON) customBtns icon is required.
    2004734Body (JSON) customBtns ui is required.
    2004735Body (JSON) customBtns ui is invalid.
    2004736Body (JSON) customBtns flow is invalid.
    2004706Enter an option value for Body (JSON).
    2004801No player information.
    2004804The 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. "
      }
    }
    

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

    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.