画質情報照会
    • PDF

    画質情報照会

    • PDF

    記事の要約

    Live Stationで生成した画質の詳細情報を照会するAPIです。

    リクエスト

    GET https://livestation.apigw.ntruss.com/api/v2/qualityProfiles/{qualityId}
    

    リクエストヘッダ

    ヘッダ名必須可否説明
    x-ncp-apigw-timestampYES1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとしてみなす。
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyYESNaverクラウドプラットフォームポータルで発行されたAccess Key IDの値
    x-ncp-iam-access-key:{Sub Account Access Key}
    x-ncp-apigw-signature-v2YESAccess Key ID値とSecret Keyで暗号化した署名
    x-ncp-apigw-signature-v2:{API Gateway Signature}
    x-ncp-region_codeYESリージョン·コード (KR)

    レスポンス

    フィールド名タイプ説明備考
    idInteger
    nameString画質プロファイル名
    typeStringAUDIO, NORMAL
    genTypeStringCUSTOM,SYSTEM
    statusString
    videoObjectif type = AUDIO, video Object doesn not need.
    video.fpsInteger1 ~ 60 fps
    video.birateInteger1 ~ 204800000 bpsUnit: bps
    video.bframesInteger0 ~ 4
    video.levelInteger-1AUTO: -1
    video.widthInteger16 ~ 4096
    video.heightInteger16 ~ 4096
    video.bypassBoolean
    video.orientationStringFIX, FREEFIX
    video.keepRatioBoolean
    video.codecStringH264
    video.profileStringBASELINE, MAIN, HIGH
    video.rateControlIntegerVBR,CBRVBR
    video.videoH264ParamRefFramesInteger11
    audioObject
    audio.codecStringAAC, MP3AAC
    audio.profileStringLCLC
    audio.samplerateIntegerAAC : [8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000]
    MP3 : [8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000]
    44100
    audio.channelsIntegerAAC : 0 ~ 8
    MP3 : 0 ~ 2
    0
    audio.bitrateInteger16 ~ 320 kbpsUnit: kbps
    audio.bypassBooleanfalse
    inUseQualitySetNameArray
    inUseChannelNameArray
    createdTimeTimestamp

    例示

    リクエスト例示

    GET /api/v2/qualityProfiles/23
    HOST: livestation.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
    
    

    レスポンス例示

    HTTP/1.1 200 OK
    Server: nginx
    Date: Wed, 12 Sep 2018 09:53:32 GMT
    Content-Type: application/json;charset=utf-8
    Connection: keep-alive
    Access-Control-Allow-Origin: *
    x-ncp-trace-id: 36c9k60om4p3238cpmc9gm4cj4
    
    {
        "content": {
            "audio": {
                "bitrate": 192,
                "bypass": false,
                "channels": 0,
                "codec": "AAC",
                "profile": "LC",
                "samplerate": 44100
            },
            "createdTime": 1585656323000,
            "genType": "CUSTOM",
            "id": 23,
            "inUseChannelNames": [],
            "inUseQualitySetNames": [],
            "name": "testquality-api",
            "status": "CREATED",
            "type": "NORMAL",
            "video": {
                "bframes": 0,
                "bitrate": 2000000,
                "bypass": false,
                "codec": "H264",
                "fps": 30.0,
                "height": 1080,
                "level": -1,
                "profile": "MAIN",
                "rateControl": "CBR",
                "width": 1920
            }
        },
        "result": "success"
    }
    

    エラーコード

    Live Station APIリクエストが誤っているか、処理中にエラーが発生するとHTTPステータスコードで成功/失敗を返却し、JSON形式で詳細メッセージを返却します。

    エラーコードはLive Station APIの'共通エラーコード'と'API Gatewayエラーコード'の2つです。

    エラーコードレスポンスメッセージ説明
    250000Unexpected error occurred.エラーが発生しました。
    250001{0}エラーが発生しました。
    250002{0}: invalid value.リクエスト値のフォーマットが正しくありません。
    250003Missing required header.必須要請ヘッダーが抜けました。
    250004{0} not found.リクエストリソースが見つかりません。
    250005{0} not available.リクエストリソースを使用できません。
    250006Unauthorized {0}.リクエストリソースに権限がありません。
    250007{0} connection failed.コネクション接続に失敗しました。
    250008Request failed.リクエストに失敗しました。
    250009Third-party interface exception: {0}.内部エラーが発生しました。
    250010We cannot accomplish the task as permissions are not granted for the sub account.
    Please modify permissions for the account through the Sub Account service.
    Sub Account権限が十分ではありません。
    250011{0} must has a valid value有効な値ではありません。
    250012Invalid request data,please checkデータが有効ではありません。
    250013OK
    250014Form validation failedデータが有効ではありません。
    250015Access denied接近できません。
    250016Server errorサーバエラーが発生しました。
    250017Unauthorizedリクエストリソースに権限がありません。
    250018Bad Request誤った要請です。
    250019The Region {0} not support now.現在サポートしていないリージョンです。
    250020Invalid region code {0}.無効なリージョンコードです。
    250021Invalid parameter type.{0} can not convert to type {1}.無効なパラメ一夕タイプです。
    250022The url that you specified is not invalid format.URL の形式が正しくありません。
    250100Channel is not foundチャンネルが見つかりません。
    250101This channel is not publishing now現在送出中のチャンネルではありません。
    250102This channel is publishing現在送出中のチャンネルです。
    250103This channel has never been published.一度も送出されたことのないチャンネルです。
    250104Channel names can be entered with a minimum of 3 characters and a maximum of 20 characters. Special character “_” allowed.チャンネル名がLive Stationでサポートする形式ではありません。
    3文字以上20文字以下、"_"許容
    250105Start publish failed
    250106Stop publish failed
    250107This channel's CDN is not runningこのチャンネルのCDNが動作しません。
    250108CDN secure token cannot set
    250109If CDN status is creating or changing, channel cannot be deleted.CDN状態が生成中または変更中であればチャンネルを削除できません。
    250110Cannot create channel, reason: {0}
    250111Wrong notification typeNotification タイプが正しくありません。
    250112Cannot configure Notification
    250113In order to return channel, CDN must be returned first.
    250114Channel can be deleted only in 'READY' state.READY状態のCHANNELのみ返却できます。
    250115The channel didn't set DVRDVR が設定されていないチャンネルです。
    250116The request did not include the required "QualitySet"
    250118The request did not include the required "CDN_TYPE"
    250119The cdnInstanceNo is needed when createCdn is false.
    250120The cdn type that you specified is not allowed: only "CDN_PLUS", "GCDN" is supported.対応していないCDNタイプです。
    "CDN_PLUS", "GCDN"のみ支援
    250121The request channel did not set useDvr.
    250122The timemachineMin should be 360.timemachineMinは360分でのみ設定できます。
    250123The specified channel Id does not exist.存在しないチャンネルIDです。
    250124The request does not allowed: You can get url only cdn status is "RUNNING"
    250125The request does not allowed: You can get url only channel status is "READY"
    250126The number of professional type can not exceed 5 : targetPlatform is allowed between 1 and 5
    250127The plan type that you specified is not allowed.
    250128The number of standard plan type can not exceed 3 : targetPlatform is allowed between 1 and 3
    250129The input of rtmp url that you specified is not allowed
    250130The restream targetName value that you specified is not allowed : [STEAM, MIXER , TWITCH , YOUNOW , USTREAM , AFREECA_TV , NAVER_TV , V_LIVE, LINE_TV , PRISM, LIVESTATION, CUSTOM] ar e supported.
    250131The channel value that you specified is not allowed.
    250133The request channel did not set useDvr
    250134The request channel status is no "PUBLISHING"
    250135The request does not allowed : the recording has been start already
    250136The request does not allowed : the recording has been start already
    250137The request does not allowed : the recording status is not "TRUE"
    250138The param timemacineMin is needed when useDvr is true.
    250139The param immediateOnair should be false when useDvr is false.
    250140Cdn status should be running when create channel.
    250141You can get time machine url only recording status is TRUE.
    250142ChannelName should not be null.
    250143The request did not include the required "stream key".
    250300Quality is not found.
    250301The qualitySetId that you specified not found.
    250302Quality set must have only one 1080p quality.
    250303Delete system quality profile is not allowed.
    250304Invalid user info.
    250305System resource cannot updateSystemリソースはアップデートできません。
    250306Resource is in use現在使用中のリソースです。
    250307The segment duration value that you specified is not allowd (exceeds valid limit or wrong type) : valid value is allowed integer value between 1000 and 10000 in 500 units is supported. (unit : milliseconds )
    250309The segment count value that you specified is not allowed (exceeds valid limit or wrong type): valid value is allowed integer between 2 and 10
    250311Delete system quality set is not allowed.Systemリソースは削除できません。
    250312Only Alphabets, Numbers and Hypen are allowed. The length must be between 3 and 20 characters.英文、数字、"-"許容、3者以上20字
    250313quality size error (min:1, max:4)Qualityは最低1つ、最大4つまで設定することができます。
    250314Video codec must have a value
    250315Video codec profile must have a value
    250316Video codec profile level must have a value
    250321Video bitrate must be greater than or equal to 1
    250322Video bitrate must be less than or equal to 20000000
    250323Video B frames must be greater than or equal to 0
    250324Video B frames must be less than or equal to 4
    250325Audio codec must have a value
    250327Audio sampling rate must have a value
    250328Audio channels must have a value
    250333{0} Profile only when AAC
    250334bFrames only 0 is available if resolution less than 409920(854*480)
    250335bFrames only 0,1,2 are available if resolution less than 921600 (1280*720)
    250336Video frame rate must be greater than or equal to 1Videoframerateは1以上に設定する必要があります。
    250337Video frame rate be less than or equal to 60Videoframerateは60以下に設定する必要があります。
    250338Audio channels must be greater than or equal to 0オーディオチャンネルは0以上に設定する必要があります。
    250339Audio channels must be less than or equal to 8オーディオチャンネルは8以下に設定する必要があります。
    250341Only profile 'BASELINE' available for resolution less than 921600 (1280*720)
    250342Only even integer are available for video width and height
    250343Interval must bigger than 0Intervalは無条件で0より大きい必要があります。
    250344Must input key
    250345Must input header
    250348The request did not set content-type to "application/json"
    250351The timedmeta that you specified is not allowed: only integer "1000" is supported.
    250353The audio codec that you specified is not allowed: only "AAC", "MP3" audio codec is supported.
    250354The profile value of audio codec that you specified is not allowed: only profile LC is supported.
    250355The audio channel value that you specified is not allowed: only audio channel value [0, 1,2,3,4,5,6,7,8] are supported
    250356The audio channel value that you specified is not allowed: only audio channel value [0, 1, 2] are supported.
    250357The audio bitrate value that you specified is not allowed(exceed valid limit or wrong type): valid value is allowed integer between 16 and 320.
    250358The audio sampling rate that you specified is not allowed: only audio sampling rate value AAC: [8000, 11025, 12000, 16000, 22050, 24000,32000, 44100, 48000, 64000,88200,96000] are supported.
    250359The audio sampling rate that you specified is not allowed: only audio sampling rate value MP3:[8000,11025, 12000,16000,22050,24000,32000,44100,48000] are supported.
    250360The video codec that you specified is not allowed: only "H264" format is supported.
    250361The profile of video codec that you specified is not allowed: only profile value [BASELINE, MAIN, HIGH] are supported.
    250362The orientation of video that you specified is not allowed: only [FIX] is supported.
    250363The profile level of video that you specified is not allowed. only [0] is supported
    250364The reference frames of video that you specified is not allowed, only [1] is supported.
    250365The video  bitrate value that you specified is not allowed: video bitrate value is an integer greater than 0
    250366The width of video that you specified is not allowed: only width [integer between 128 and 1920] are supported.
    250367The height of video that you specified is not allowed: only height [integer between 96 and 1920] are supported.
    250368The frame rate of video that you specified is not allowed : only frame rate value [10, 15, 23.97, 24, 29.97, 30, 50, 60] are supported.
    250370The rate control of video that you specified is not allowed : only width [VBR, CBR] are supported.
    250372The request did not include the required "video" object
    250373The request did not include the required "audio " object
    250374Delete system quality profile is not allowed.System quality profile は削除できません。
    250375The request did not include the required "timedMetadata" object.(if "enableHlsTimedMetadata": true, timedMetadata object should be included.)
    250376The timedmeta that you specified of key is not allowed: only "utc" is supported.
    250377The request did not include the required "enableHlsTimedMeta"
    250378The request do not include the required "audio bitrate"
    250500Record filename is not valid : {0}レコーディング·ファイル名が有効ではありません。
    250501Record filename is not found : {0}レコーディングファイルが見つかりません。
    250502Record file upload errorレコーディングファイルをアップロード中にエラーが発生しました。
    250504Can not delete Record file: {0}レコーディングファイルは削除できません。
    250505Can't get objectStorage's access oAuthObject Storageにアクセスできる権限獲得に失敗しました。
    250506ChannelId param should not be null when get record list.レコーディングリストを照会するとき、CHANNEL IDパラメータが必要です。
    250507Record status should be TRANSFER_READY or TRANSFER_FAIL when upload.レコーディング·ファイルがアップロードできる状態ではありません。
    TRANSFER_READY, TRANSFER_FAIL 状態の時のみ可能
    250600Number must bigger than or equal to 1
    250700The record id has been requested already.
    250701The record id that you request upload does not exist.
    250702The record id does not exist.
    250703The input bucket name that you specified is not allowed.
    250704The output bucket name that you specified is not allowed.
    250705The input bucket name doesn't exist.

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

    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.