label: string

Default value: "Upload with Clipchamp!"

삽입된 버튼의 라벨. 랩퍼 요소에 위치한 버튼에 표시되는 텍스트입니다.

size: string

Default value: "medium"
Allowed values:
tiny small medium large

Clipchamp 버튼의 크기입니다. 4가지 크기 중에서 선택하십시오.

title: string

Default value: "Ye' olde video-upload shoppe"

사용자가 삽입된 버튼을 클린한 후 나타나는 UI의 제목입니다. 제목은 iframe 팝업 상단에 표시됩니다.

logo: string

Default value: "https://api.clipchamp.com/static/button/images/logo.svg"

UI 로고 이미지의 URL. iframe의 상단 왼쪽에 표시되는 이미지입니다.

color: string

Default value: "#303030"

Clipchamp 버튼의 색상, 팝업 제목표시줄의 배경 및 기타 그래픽 요소를 결정합니다. 색상 이름 (예 blue), 16진수 색 코드 (예 #3300cc), 또는 RGB 코드 색상 (예 rgba(78,24,212,0.5)) 가능합니다.

style: object

Default value: undefined

CSS를 사용하여 Clipchamp API의 시각적 모양을 세부적으로 사용자 정의할 수 있습니다. 사용자 맞춤 CSS 스타일시트는 URL (style.url 속성) 또는 CSS 선언 문자열 (style.text)로 제공될 수 있습니다. 두 가지 경우 모두, 사용자 맞춤 CSS 선언은Bootstrap 3 기본 스타일링을 기반으로 기본 사용자 인터페이스 스타일을 대체하지 않지만 증가시킵니다. 즉, 사용자 맞춤 CSS 스타일은 기존 CSS 클래스를 추가될 수 있는 기존 CSS 스타일의 위에 겹쳐지며, CSS 속성을 추가하거나 대체할 수 있습니다. 엔터프라이즈 요금제.

inline: object

Default value: undefined

삽입 페이제에서 지정된 랩퍼 요소가 배치된 Clipchamp 위젯이 포함된 <iframe>에 API의 위젯의 인라인 배치를 허용합니다. 엔터프라이즈 요금제.

inputs: Array<string>

Default value: ["file", "camera"]
Allowed values:
file camera direct

사용자가 웹캠용 camera 및 컴퓨터 파일 시스템용 file에서 입력 동영상을 선택할 수 있는 소스. direct 옵션은 direct.files 매개 변수를 통해 직접 최종 사용자의 작업 없이 입력 동영상 파일을 받을 수 있도록 Clipchamp API에 지시합니다. 따라서 direct 입력 옵션은 다른 두 옵션과 함께 사용해서는 안됩니다 (file, camera). directfile 또는 camerainputs 배열에 주어진 경우, filecamera 옵션은 무시되고 direct.files 매개 변수는 Blob 인스턴스의 배열로 간주됩니다.

output: string

Default value: "dummy"
Allowed values:
dummy blob azure s3 youtube gdrive dropbox

출력 동영상을 사용할 수 있거나 업로드 할 대상. “blob”이 선택된 경우, 클라이언트 측 자바스크립트 코드에 Blob으로 출력 동영상을 제공합니다. “유튜브”, “애저” 또는 “s3″를 선택한 경우, 구성 페이지에서 적절한 계정으로 동영상을 업로드 할 수 있도록 권한을 부여해야 합니다. “dummy” 출력은 아무것도 출력하지 않지만 간단한 타이머를 사용하여 업로드를 시뮬레이션하고 백엔드를 구성하지 않고 초기 통합 및 테스트에 사용할 수 있습니다.

upload: object

Default value: undefined

지원되는 업로드 대상에서 업로드 프로세스를 구성하는 설정.

camera: object

Default value: undefined

카메라 녹화를 사용자 정의하기 위한 구성 요소.

direct: object

Default value: undefined

입력 매개 변수 내의 direct 옵션에 적용되는 추가 매개 변수.

enable: Array<string>

Default value: []
Allowed values:
batch fixup-webcam-webm mobile-webcam-format-fallback no-branding no-error-bypass no-hidden-run no-popout no-probe-reject no-thank-you no-user-retry

Clipchamp API의 특수 동작 사용:

  • batch – 사용자 상호 작용없이 순서대로 처리하고 업로드되는 여러 파일.
  • fixup-webcam-webm – 적시간 메타데이터가 잘못되거나 누락될 수 있는 WebM 웹캠 녹화 “수정”. 삽입된 동영상 메타데이터가 정확하고 완전한 WebM 파일을 동영상 처리 파이프라인의 후속 단계에서 받으려면 이 플래그를 사용하십시오. 이 플래그는 모바일 디바이스에서는 적용되지 않습니다 (mobile-webcam-format-fallback 플래그가 설정된 안드로이드 휴대 전화). 베타
  • mobile-webcam-format-fallback – 대상 포맷을 사용할 수 없는 경우에도 모바일 디바이스에서 웹캠 녹화 압축을 할 수 있습니다 (실험). 이 플래그로 Clipchamp API가 VP8 또는 VP9 동영상 코덱을 사용하여 WebM 파일을 생성하는 안드로이드의 크롬에서만 이 기능을 현재 사용할 수 있습니다.
  • no-branding – 요금제에서 사용 가능한 경우, 사용자 지향 UI에서 Clipchamp 브랜딩을 제거합니다. 삽입 버튼에는 적용되지 않습니다. 삽입 버튼의 스타일을 지정하려면 사용자 맞춤 버튼 API를 사용하십시오 (요금제에서 사용 가능한 경우).
  • no-error-bypass – 어떠한 이유로든 트랜스코딩이 실패하면 일반적으로 Clipchamp는 입력 파일을 그대로 업로드하는 것에 의존합니다. 이 플래그는 해당 동작을 억제합니다. 트랜스코딩 실패의 가장 일반적인 원인은 지원되지 않는 입력 코덱입니다.
  • no-hidden-run – 사용자가 “제출”을 클릭한 후 닫으면 백그라운드에서 계속해서 처리 및 업로드하려면 옵션을 비활성화하십시오.
  • no-popout – 일부 브라우저는 타사 코드의 특징 기능 사용을 차단합니다. 이것이 감지되면, Clipchamp는 이러한 기능에 액세스하기 위해서 새 창을 엽니다. no-popout 설정하면 이 동작을 억제하고, Clipchamp가 사용 가능한 기능을 수행하도록 합니다. 이로 인해 메모리 요구 사항이 증가할 수 있습니다.
  • no-probe-reject – 입력 파일이 동영상인지 판별할 수 없는 경우에는 일반적으로 거부됩니다. 이 옵션은 모든 입력 파일을 허용하고 동영상 파일이 아닌 경우 업로드하기 위해 바로 건너 뜁니다.
  • no-thank-you – 감사 화면을 비활성화하고 즉시 창을 닫습니다. 처리 중 오류가 발생하면 마지막 화면이 계속 표시됩니다.
  • no-user-retry – 웹캠 녹화가 완료되고 파일이 업로드되기 전에 사용자 확인 및 재시도 옵션을 비활성화합니다. 이 플래그를 추가하면 웹캠 녹화가 끝난 후 즉시 업로드가 시작됩니다. 사용자는 웹캠 녹화를 반복할 기화가 없습니다.

experimental: Array<string>

Default value: []
Allowed values:
force-popout overlong-recording h264-hardware-acceleration

Clipchamp API의 실험적 동작 사용

  • force-popout – 삽입하는 웹사이트의 DOM 내부에서 iframe 내에서 실행할 수도 있지만, 별도의 “팝업” 브라우저 창에서 Clipchamp API의 사용자 인터페이스를 항상 실행합니다. no-popout 플래그 (enable) 매개변수와 함께 사용하지 마십시오.
  • overlong-recording – 녹화 시간 제한 없이 웹캠/모바일 카메라 녹화 허용 (그렇지 않으면 Clipchamp API에 의해 시행됨). 녹화 시간은 camera.limit 매개 변수의 초 단위를 설정하여 의도적으로 제한할 수 있습니다. 클라이언트는 지원되는 브라우저 (현재: 크롬, 오페라, 파이어폭스) 에만 overlong-recording 플래그를 설정해야 합니다.
  • h264-hardware-acceleration – 지원되는 플랫폼 (현재: x86 기반 크롬 OS/크롬북 디바이스)에서 하드웨어 가속 H.264 동영상 인코딩을 사용합니다. 플래그는 web (기본값) presetmp4 (기본값) 포맷에만 적용됩니다. 기본 하드웨어에 따라서, h264-hardware-acceleration 플래그 설정 시 여러 배의 속도 향상을 얻을 수 있습니다. 클라이언트는 동일한 (주관적인) 인지된 출력 품질에 대해 다른 압축율을 경험하므로 허용 가능한 품질/압축 트레이드오프를 산출하기 위해 compression 매개 변수를 조정하는 것이 좋습니다.

dropbox: object

Default value: undefined

드롭박스 업로드 대상 사용 시 구성 요소.

youtube: object

Default value: undefined

유튜브 업로드 대상 사용 시 구성 요소.

onWebcamStatusChange(status): function

이 콜백 함수는 status가 녹화 또는 웹캠의 새로운 상태를 반영하는 String인 웹캠 또는 휴대전화 카메라 및 동영상 녹화에 영향을 미치는 여러 이벤트에 대해 호출됩니다:

  • capture_started – 웹캠 또는 휴대전화 카메라의 전원이 켜져 있고 동영상 스트림을 캡처합니다 (아직 녹화하지 않음)
  • capture_ended – 웹캠 또는 휴대전화 카메라의 전원이 꺼져있고 더 이상 동영상 스트림을 캡처하지 않습니다
  • capture_failed – 웹캠 또는 휴대전화 카메라에 액세스 실패
  • recording_running – 이전에 일시 정지된 후 웹캠 녹화가 시작되었거나 다시 시작되었습니다
  • recording_paused – 웹캠 녹화가 일시 중지되었고 나중에 다시 시작하거나 종료할 수 있습니다
  • recording_finished – 웹캠 녹화가 종료되었지만 업로드되기 전에 처리 중이거나 onVideoCreated 콜백에서 사용할 수 있습니다
  • recording_cancelled – 웹캠 녹화가 취소되었습니다

웹캠 또는 휴대전화 카메라의 상태 추적은 데스크톱 브라우저에서 (mobile-webcam-format-fallback 플래그가 enable 매개 변수 배열에 설정된 경우 안드로이드 크롬에서) 지원됩니다.

onMetadataAvailable(metadata): function

이 콜백 함수는 웹캠 녹화 또는 입력 동영상 파일이 성공적으로 분석되었을 때 모든 웹캠 녹화 및 입력 동영상 파일에 대해 호출됩니다. metadata 매개 변수는 다음과 같은 속성을 가진 객체입니다:

  • raw – 미가공 동영상 메타데이터는 다음 속성을 가진 객체입니다:
    • format – 동영상 컨테이너 포맷 정보
    • streams – 동영상, 오디오, 자막, 데이터 등의 배열. 동영상에 포함된 스트림

사용자가 동영상 녹화를 지우고 반복하도록 선택하면, 이 콜백은 여러 녹화의 메타데이터로 여러 번 호출됩니다. 또한 사용자가 여러 입력 동영상을 선택할 수 있는 batch 플래그를 사용할 경우, onMetadataAvailable은 여러 번 호출됩니다. 베타

onPreviewAvailable(imageBlob): function

onPreviewAvailable은 미리보기 이미지가 있는 경우 같이 호출 됩니다. 매개변수는 URL이 아닌 Blob인스턴스이며, 이미지는 출력 동영상과 함께 지정된 업로드 대상에 업로드되지 않습니다. 또한, 모든 시나리오에서 미리보기 이미지를 생성하지 않으며, 특히 입력 동영상이 손상되거나 유효하지 않거나 불완전한 메타데이터를 포함한 경우 그러합니다. 베타

onUploadComplete(data): function

이 콜백 함수는 단일 data 객체는 업로드된 파일에 대한 메타 정보가 포함하며 여기에 출력 동영상 업로드가 완료되면 호출됩니다. 두 가지 공통 속성이 있습니다:

  • filename – 원본 동영상 파일명
  • duration – 동영상 지속시간. 특정한 경우 이 칸은 없을 수 있습니다

다양한 output 관련 속성이 있습니다:

  • “유튜브” 출력을 사용하는 경우
    • kind – “유튜브”
    • id – 동영상 ID
    • url – URL 뷰
    • embedHtml – 동영상 삽입을 위해 유튜브에서 제공한 HTML 스니펫 (제공된 경우).
  • “애저” 출력을 사용하는 경우
    • kind – “애저”
    • blob – 업로드를 저장할 때 궁극적으로 사용된 실제 애저 blob 이름.
  • “s3” 출력을 사용하는 경우
    • kind – “s3”
    • key – 업로드를 저장할 때 궁극적으로 사용된 실제 아마존 S3 객체 키.
  • “구글 드라이브” 출력을 사용하는 경우
    • kind – “구글 드라이브”
    • id – 구글 파일 ID
    • name – 구글 드라이브에 저장된 파일명.
    • url – 파일에 대한 URL
    • folder – 상위 레벨인 경우 “루트” 또는 파일이 있는 구글 폴더 ID.
  • “드롭박스” 출력을 사용하는 경우
    • kind – “드롭박스”
    • id – 드롭박스 파일 ID
    • name – 드롭박스에 저장된 파일명
    • path – 드롭박스의 파일 경로
    • link – 드롭박스의 파일 공유 링크 (Clipchamp API 설정에서 해당 옵션을 토글해야함)
  • “blob” 출력을 사용하는 경우
    • kind – “blob”
    • dataonVideoCreated 생성한 배열

onVideoCreated(blob [,done [,fail [,notify]]]): function

출력이 blob로 설정되고 출력 동영상 blob이 첫 번째 매개변수로 전달되는 경우, onVideoCreated가 호출됩니다. Blob은 이 함수가 처리를 완료할 때까지 유효합니다. 함수는 다음 3가지 경우 중 하나를 사용하여 결정됩니다:

  1. 함수 시그니처에 적어도 완료된 매개 변수가 포함되어 있고, done 또는 fail 콜백이 호출된 경우.
  2. promise (또는 thenable) 가 반환되는 경우, 해결되거나 거절될 때까지 기다립니다.
  3. 함수가 promise가 아닌 다른 것으로 반환하고, 최소 done 콜백 매개 변수를 지정하지 않은 경우, 반환 시 즉시 처리가 완료된 것으로 간주합니다.

함수 처리가 완료될 때까지, 출력 파일은 “업로드 중”으로 간주됩니다. 진행 보고가 가능한 promise가 반환되거나 (즉, 함수가 세 번째 콜백을 수락하는 경우), notify 콜백이 사용된 경우, 숫자 진행률은 업로드 완료율로 해석되며 화면에 그대로 표시됩니다. 처리가 완료된 후 (위의 결정처럼) 지원 저장소가 삭제되었을 수 있으므로 blob을 더 이상 안정적으로 사용할 수 없습니다.

onErrorOccurred(error): function

동영상 녹화, 처리 또는 업로드 또는 웹캠/카메라 녹화 중 오류가 감지될 경우 onErrorOccurred가 호출됩니다. error 매개 변수는 필수 type 속성이 있는 객체이며, 다음 중 하나입니다:

  • webcam_processing, 웹캠 (또는 휴대전화 카메라) 녹화 중 오류가 발생한 경우;
  • video_processing, 동영상을 업로드 하기 전에 입력 동영상 또는 웹캠/카메라 녹화가 처리 (코딩/압축)되는 동안 오류가 발생한 경우;
  • video_uploading, 처리된 출력 동영상이 선택된 저장 위치에 업로드되는 동안 오류가 발생한 경우;
  • other_unknown, 다른 원인 또는 알려지지 않은 오류인 경우;

두 번째 (선택 사항) 속성 message는 사람이 읽을 수 있는 오류 설명을 의미합니다. 사용자에게 오류 메시지를 보여주기 위해 message 속성의 문자열 값을 사용할 수 있습니다. 선택 사항인 details 속성은 예외, 오류 이벤트와 같은 오류에 대한 추가 기술 정보가 포함된 배열입니다. Clipchamp 지원에 문제를 알리고자 할 경우 details 속성 값을 사용하십시오. 동일한 근본 원인으로 인하여 onErrorOccurred 콜백이 여러 번 호출 되는 경우가 있습니다. Clipchamp API에는 onErrorOccurred 콜백에 보고되는 일부 인스던트를 보안하기 위한 조항이 있습니다. 예를 들어, no-probe-reject 플래그 (가능 매개변수 참조)는 파일에서 기술 메타데이터를 추출할 수 없더라도 동영상 파일이 동영상 트린스코딩 엔진으로 전달되도록 합니다.

localization: object

Default value: undefined

지역화에 사용할 수 있는 문자열 테이블. 영어가 아닌 경우, 웹사이트의 언어로 표시되도록 API의 모든 사용자 지향 요소를 조정하는데 사용합니다. 사용자에게 전혀 표시하고 싶지 않은 텍스트 스니펫을 지우는데도 이 문자열을 사용할 수 있습니다.