채널 생성
    • PDF

    채널 생성

    • PDF

    Article Summary

    Live Station 의 채널을 생성하는 API 입니다. 생성한 채널 조회를 위해 채널 목록 조회 API채널 정보 조회 API를 제공합니다.

    참고
    • 송출 이중화 설정을 사용 하실 경우, 반드시 메인 스트림을 먼저 송출 하셔야 합니다.
    • Low Latency 용 화질 세트를 활용하여 채널 생성할 경우, LL-HLS 채널을 생성하실 수 있습니다.
    • LL-HLS 이용 시 신규 CDN을 생성을 권장합니다.
    • 기존 생성된 CDN을 사용하실 경우, 기존 생성된 CDN 갱신이 필요합니다. CDN 갱신 방법은 사용자 가이드를 참고해주세요.
    • 원활한 LL-HLS 채널 사용을 위해 키프레임을 1초로 설정하시길 권장합니다. 자세한 송출 가이드는 사용자 가이드 를 참고하세요.

    요청

    POST https://livestation.apigw.ntruss.com/api/fin-v2/channels
    

    요청 헤더

    헤더명필수 여부설명
    x-ncp-apigw-timestampYES1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
    x-ncp-apigw-timestamp:{Timestamp}
    x-ncp-iam-access-keyYES네이버 클라우드 플랫폼 포털에서 발급받은 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}
    Content-TypeYESRequest body content type을 application/json으로 지정
    Content-Type: application/json
    x-ncp-region_codeYES리전 코드 (FKR)

    요청 바디

    필드명필수 여부타입제약 사항설명
    channelNameYesString최소 3글자 이상 최대 20자 문자까지 입력 가능
    특수 문자 붙임표(-) 허용
    생성할 채널의 이름
    envTypeOptionalStringDEV, STAGE, REAL생성할 채널의 사용 구분을 위한 설정
    입력 하지 않을 경우 REAL 로 설정됨
    outputProtocolOptionalStringHLS / HLS, DASH출력 프로토콜 설정
    입력 하지 않을 경우 HLS 로 설정됨
    cdnYesObjectCDN Object
    cdn.createCdnYesBooleantrue, falseCDN Object
    cdn.cdnTypeYesStringCDN_PLUS
    cdn.cdnInstanceNoOptionalIntegercdn.createCdn 이 false 일 경우 반드시 설정해야 함
    qualitySetIdYesIntegerLL-HLS 채널을 생성할 경우, Low Latency 화질 설정을 요청
    useDvrYesBooleantrue, false
    immediateOnAirOptionalBooleantrue, false송출과 동시에 녹화가 진행되는 자동 녹화 옵션
    timemachineMinOptionalInteger단위는 분(minutes) 이며 360 으로만 설정 가능녹화 시작 시점까지 영상을 되돌려 볼 수 있는 타임머신 기능 관련 옵션
    useDvr 이 true 일 경우 반드시 설정해야 함
    recordYesObject
    record.formatOptionalStringMP4,HLS,ALL버킷으로 자동 저장 되는 녹화 파일의 타입을 지정
    record.typeYesStringNO_RECORD, AUTO_UPLOAD, MANUAL_UPLOAD저장된 녹화 파일 업로드 타입을 지정
    "NO_RECORD" 로 설정 시 녹화 기능 사용 불가
    record.bucketNameOptionalString자동 저장 기능을 통해 라이브 방송 종료 후 입력한 Bucket 에 녹화 파일이 자동 저장
    record.filePathOptionalString자동 저장 기능을 통해 라이브 방송 종료 후 지정한 filePath 에 녹화 파일이 자동 저장
    filePath 는 "/" 부터 시작 해야함
    record.accessControlOptionalStringPRIVATE, PUBLIC_READ자동 저장 기능을 통해 녹화 파일 업로드시 Object Storage Bucket 공개 범위를 지정하는 옵션 (Default: PRIVATE)
    isStreamFailOverOptionalBooleantrue, false송출 이중화 적용을 위한 옵션
    송출 이중화 설정을 통해 송출 인코더 이중화 구성

    응답

    필드명타입설명비고
    channelIdString
    channelNameString
    envTypeStringDEV, STAGE, REAL
    cdnObject
    cdn.createCdnBoolean
    cdn.cdnTypeStringCDN_PLUS, GLOBAL_CDN
    cdn.cdnInstanceNoInteger
    qualitySetIdInteger
    useDvrBoolean
    immediateOnAirBoolean
    timemachineMinInteger
    recordObject
    record.formatStringMP4,HLS,ALL
    record.typeStringNO_RECORD, AUTO_UPLOAD, MANUAL_UPLOAD
    record.bucketNameString
    record.filePathString
    record.accessControlStringPRIVATE, PUBLIC_READ
    uploadPathStringAUTO_UPLOAD 옵션일때 녹화 파일 업로드 경로
    backupStreamKeyString송출 이중화를 위한 백업 스트림키
    isStreamFailOverBoolean송출 이중화 설정 적용 여부true, false
    originObjectCDN 연동을 위한 Live station 원본 정보
    origin.originDomainStringCDN 연동을 위한 Live station 원본 도메인
    origin.originPathStringCDN 연동을 위한 Live station 원본 상세 경로

    예시

    요청 예시

    POST /api/fin-v2/channels
    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:FKR
    
    Request body (if cdn.createCdn == true) 
    {  
       "channelName" : "testchannel",
       "cdn" : {
          "createCdn" : true,
          "cdnType" : "CDN_PLUS"
       },
       "qualitySetId" : 12345,
       "useDvr" : true,
       "immediateOnAir" : true,
       "timemachineMin" : 360,
       "record": {
             "type": "AUTO_UPLOAD",
             "format": "MP4",
             "bucketName": "hls",
             "filePath": "/livestation",
             "accessControl": "PRIVATE"
      },
      "isStreamFailOver": true
    }
    
    Request body (if cdn.createCdn == false) 
    {  
       "channelName" : "testchannel",
       "cdn" : {
          "createCdn" : false,
          "cdnType" : "CDN_PLUS",
          "cdnInstanceNo" : 123456
       },
       "qualitySetId" : 12345,
       "useDvr" : true,
       "immediateOnAir" : true,
       "timemachineMin" : 360,
          "record": {
             "type": "AUTO_UPLOAD",
             "format": "MP4",
             "bucketName": "hls",
             "filePath": "/livestation",
             "accessControl": "PRIVATE"
      },
      "isStreamFailOver":true
    }
    

    응답 예시

    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
    
    {
      "content": {
         "channelName" : "testchannel",
         "channelId" : "ls-20200217154656-Rnd49",
         "cdn" : {
            "createCdn" : true,
            "cdnType" : "CDN_PLUS",
            "cdnInstanceNo" : 123456
         }
         "qualitySetId" : 12345,
         "useDvr" : true,
         "immediateOnAir" : true,
         "timemachineMin" : 360,
          "envType": "REAL",
          "outputProtocol": "HLS",
          "uploadPath": "/hls/livestation",
           "record": {
              "type": "AUTO_UPLOAD",
              "bucketName": "hls",
              "filePath": "/livestation",
              "format": "MP4",
              "accessControl": "PRIVATE"
        },
        "origin": {
           "originDomain": "ls-k1.video.media.ntruss.com",
            "originPath": "1"
       },
      "backupStreamKey": "lbuy4dcrxk2ctxs8uqxanpy833p08vvz?backup=true",
      "isStreamFailOver": true
      }
    }
    

    이 문서가 도움이 되었습니까?

    What's Next
    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.