/문서/(문서ID)/레이어/(레이어ID)/setLiveFirstVariant

지원되는 메서드: "GET" "POST"
레이어의 첫 번째 변형을 활성화하고 레이어를 라이브로 설정합니다.

/문서/(문서ID)/레이어/(레이어ID)/setLiveLastVariant

지원되는 메서드: "GET" "POST"
레이어의 last 변형을 활성화하고 레이어를 라이브로 설정합니다.

/문서/(문서ID)/레이어/(레이어ID)/입력/(소스입력키)/미디어컨트롤/(미디어컨트롤커맨드)

지원되는 메서드: "GET" "POST"
지정된 레이어의 입력 "(SourceInputKey)"에 바인딩된 미디어로 미디어 제어 명령을 보냅니다. 입력의 소스는 어떤 명령을 지원하는지 보고하고 있습니다(/documents/(DocumentID)/sources/(SourceID) 참조).

변형

변수 쿼리하기

/문서/(문서ID)/레이어/(레이어ID)/변종

지원되는 방법: "GET"
"(LayerID)"로 지정된 레이어와 "(DocumentID)"로 지정된 문서에 대한 이형 상품 목록을 반환합니다. 반환되는 객체에 대한 자세한 내용은 "variants" 데이터 유형을 참조하세요.

/문서/(문서ID)/레이어/(레이어ID)/변종/(변종ID)

지원되는 방법: "GET", "PUT"
"(DocumentID)"로 지정된 문서에서 "(VariantID)"와 "(LayerID)"로 지정된 단일 이형 상품을 반환합니다. 반환되는 데이터에 대한 자세한 내용은 "variants" 데이터 유형을 참조하세요.

이형 상품 수정

이형 상품의 이름 또는 입력 값을 설정하려면 "PUT" 요청과 함께 JSON 인코딩된 객체를 변형 엔드포인트에 추가합니다. 변경하지 않으려는 값은 단순히 변형 엔드포인트의 JSON 당신 "PUT". 예시:

{
    "name": "New name of the Variant",
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

값을 업데이트하면 mimoLive는 업데이트된 변형 오브젝트로 응답합니다. 모든 값이 즉시 적용되지 않거나 다른 렌더링 사이클 이후에야 효과가 발생할 수 있다는 점에 유의하세요.

변형 작업

/문서/(문서ID)/레이어/(레이어ID)/변종/(변종ID)/setLive

지원되는 방법: "GET" "POST"
이형 상품을 활성화하며, 소유 레이어가 라이브가 아닌 경우 이형 상품도 라이브 상태로 전환됩니다. 이미 활성화된 이형 상품에서 이 함수를 호출해도 오류가 발생하지 않습니다. 업데이트된 이형 상품 객체가 반환됩니다.

/문서/(문서ID)/레이어/(레이어ID)/변종/(변종ID)/설정해제

지원되는 방법: "GET" "POST"
이형 상품을 비활성화합니다. 이렇게 하면 소유 레이어도 꺼집니다.

/문서/(문서ID)/레이어/(레이어ID)/바리언트/(변형ID)/토글라이브

지원되는 방법: "GET" "POST"
이형 상품을 라이브와 오프 사이를 전환합니다.

/문서/(문서ID)/레이어/(레이어ID)/변종/(변종ID)/신호/(신호ID)

지원되는 방법: "GET" "POST"
이형 상품에서 "(SignalID)"로 지정된 신호를 트리거합니다. 레이어의 "입력값" 필드(키 접미사 "_TypeSignal"로 식별)에서 "(SignalID)"를 가져올 수 있습니다.

출처

소스 쿼리하기

/문서/(문서ID)/소스

지원되는 방법: "GET"
"(DocumentID)"로 지정된 문서에 대한 소스 목록을 반환합니다. 반환되는 개체에 대한 자세한 내용은 "소스 레이어" 데이터 유형을 참조하세요.

/문서/(문서ID)/소스/(소스ID)

지원되는 방법: "GET", "PUT"
"(DocumentID)"로 지정된 문서에서 "(SourceID)"로 지정된 단일 소스를 반환합니다. 응답의 포함된 섹션에서 이 소스와 관련된 모든 "필터" 객체도 반환됩니다(사이드 로딩). 반환되는 데이터에 대한 자세한 내용은 "소스" 데이터 유형을 참조하세요.

/문서/(문서ID)/소스/(소스ID)/프리뷰

지원되는 방법: "GET"
"(DocumentID)"로 지정된 문서에서 "(SourceID)"로 지정된 소스의 그래픽 미리보기를 반환합니다. 엔드포인트는 다음 매개변수를 지원합니다:

/문서/(문서ID)/소스/(소스ID)/미디어컨트롤/(미디어컨트롤커맨드)

지원되는 방법: "GET" "POST"
미디어 지원 소스(예: 미디어 파일/재생 목록)에 대한 재생을 제어합니다. 지원되는 명령어는 소스 유형에 따라 다릅니다. 문서/(문서ID)/레이어/(레이어ID)/입력/(소스입력키)/미디어컨트롤/(미디어컨트롤커맨드)를 참조하세요.

/문서/(문서ID)/소스/(소스ID)/오픈웹브라우저

지원되는 메서드: "GET"
소스가 웹 브라우저 캡처 소스인 경우 이 작업을 수행하면 해당 웹 브라우저 창이 열립니다.

소스 수정하기

소스 이름 또는 입력 값을 설정하려면(예: 컴포지션 소스인 경우 등 소스에 있는 경우에만) "PUT" 요청과 함께 JSON 인코딩된 객체를 소스 엔드포인트에 추가합니다. 변경하지 않으려는 값은 단순히 소스 엔드포인트의 JSON 당신 "PUT". 예시:

{
    "name": "New name of the Source",
    "gain": 1.25,
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

"게인" 속성은 mimoLive 5.6에 추가되었으며 이전 버전 또는 소스에 게인 컨트롤이 없는 경우 무시됩니다. 값은 (0, 2)로 클립되며, 0은 무음, 1은 기본값, 2는 볼륨을 약 두 배로 늘립니다.

소스 작업

/문서/(문서ID)/소스/(소스ID)/시그널/(시그널ID)

지원되는 방법: "GET" "POST"
소스의 "(SignalID)"로 지정된 신호를 트리거합니다(예: 컴포지션 소스인 경우처럼 소스에 "입력값"이 있는 경우에만 해당). 소스의 "입력값" 필드에서 "(SignalID)"를 가져올 수 있습니다(키 접미사 "_TypeSignal"로 식별).

필터

필터 쿼리

/문서/(문서ID)/소스/(소스ID)/필터

지원되는 방법: "GET"
"(SourceID)"로 지정된 소스와 "(DocumentID)"로 지정된 문서에 대한 필터 목록을 반환합니다. 반환되는 개체에 대한 자세한 내용은 "filters" 데이터 유형을 참조하세요.

/문서/(문서ID)/소스/(소스ID)/필터/(필터ID)

지원되는 방법: "GET", "PUT"
"(DocumentID)"로 지정된 문서에서 "(FilterID)"로 지정된 필터와 "(SourceID)"로 지정된 단일 필터를 반환합니다. 반환되는 데이터에 대한 자세한 내용은 "필터" 데이터 유형을 참조하세요.

필터 수정하기

입력 값을 설정하려면 "PUT" 요청과 함께 JSON 인코딩된 객체를 필터 엔드포인트에 추가합니다. 변경하지 않으려는 값은 간단히 필터 엔드포인트의 JSON 당신 "PUT". 예시:

{
    "input-values": { 
        "tvGroup_Content__Subtitle": "This is a Test"
    }
}

/문서/(문서ID)/소스/(소스ID)/필터/(필터ID)/신호/(신호ID)

지원되는 방법: "GET" "POST"
필터에서 "(SignalID)"로 지정된 신호를 트리거합니다. 필터의 '입력값' 필드에서 '(SignalID)'를 가져올 수 있습니다(키 접미사 "_TypeSignal"로 식별됨).

출력 대상

출력 대상 쿼리하기

/문서/(문서ID)/출력 대상

지원되는 방법: "GET"
지정한 문서의 모든 출력 대상을 나열합니다.
반환된 개체에 대한 자세한 내용은 ""출력 대상" 데이터 유형":{TOPIC-""을 참조하세요.링크+데이터-타입시1(}. 섹션-출력-대상).

/문서/(문서ID)/출력 대상/(출력 대상 ID)

지원되는 메서드 "GET"
"(OutputDestinationID)"로 지정된 출력 대상을 반환합니다.
반환된 개체에 대한 자세한 내용은 ""출력 대상" 데이터 유형":{TOPIC-""을 참조하세요.링크+데이터-타입시1(}. 섹션-출력-대상).

출력 대상 수정하기

/문서/(문서ID)/출력 대상/(출력 대상 ID)

지원되는 메서드 "PUT", "패치"
"(OutputDestinationID)"로 지정된 출력 대상의 선택된 속성을 업데이트합니다.
업데이트된 출력 대상을 반환합니다.

다음 속성을 수정할 수 있습니다:

• "title"
• "starts-with-show"
• "스톱-위드-쇼"
• "설정" 개체의 콘텐츠( 설정 설명. 섹션-개인-설정)에서 자세한 정보를 확인하세요.)

업데이트 설명은 JSONAPI 업데이트 형식 . 크러드 업데이트). 예시:

{
  "data": {
    "type": "output-destinations",
    "id": "4FF003EA-D071-43FD-845F-DCD4A25DFA00",
    "attributes": {
      "title": "Our Recording",
      "starts-with-show": true,
      "settings": {
        "location": "~/Movies"
      }
    }
  }
}

출력 대상 작업

/문서/(문서ID)/출력 대상/(출력 대상 ID)/설정 라이브

지원되는 방법: "GET" "POST"
'(OutputDestinationID)'로 지정된 출력 대상이 올바르게 구성되고 라이브가 허용된 경우(예: mimoLive 라이선스 상태에 따라) 라이브가 시작되도록 합니다.
출력 대상이 라이브 상태가 되면 새로운 '라이브 상태'의 출력 대상이 반환되고, 그렇지 않으면 '409 충돌' 오류가 반환됩니다.

출력 대상은 라이브 스트림을 생성하기 위해 외부 서비스에 연결하는 등 라이브가 되기 전에 일부 작업을 수행해야 할 수 있으므로 반환된 출력 대상 개체는 "라이브" 상태가 아닌 "시작" 상태일 수 있습니다.

/문서/(문서ID)/출력 대상/(출력 대상 ID)/설정 해제

지원되는 방법: "GET" "POST"
"(OutputDestinationID)"로 지정된 출력 대상을 중지합니다.
출력 대상의 정지가 허용되면 출력 대상이 반환되고, 그렇지 않으면 "409 충돌" 오류가 반환됩니다.

출력 대상은 작업을 중지하기 전에 일부 작업을 수행해야 할 수 있으므로 반환된 출력 대상은 잘 구성된 출력 대상의 기본값인 '미리보기' 대신 '종료' 상태가 될 수 있습니다.

레이어 세트

레이어 세트는 mimoLive 5.0에 도입되어 여러 레이어의 라이브 상태를 한 번에 설정할 수 있어 경량화된 장면 를 사용하여 쇼의 다양한 상황을 연출할 수 있습니다. mimoLive에서만 생성 및 관리할 수 있습니다. API 액세스 권한이 획득 및 리콜 (활성화) 레이어 세트를 클릭합니다.

레이어 세트 쿼리하기

/문서/(문서ID)/레이어 세트

textileRef:9996801466400ba8908856:linkStartMarker:“지원되는 방법: "GET"
사용 가능: 미모라이브 5.0 이후
지정된 문서에 대한 모든 레이어 세트를 나열합니다.
반환된 개체에 대한 자세한 내용은 ""layer-sets"":{TOPIC-""데이터 유형"을 참조하세요.링크+데이터-typesh1(}. 섹션-레이어-세트).

/문서/(문서ID)/레이어세트/(레이어세트ID)

지원되는 메서드 “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
"(LayerSetID)"로 지정된 레이어 세트를 반환합니다.
반환된 개체에 대한 자세한 내용은 ""layer-sets"":{TOPIC-""데이터 유형"을 참조하세요.링크+데이터-typesh1(}. 섹션-레이어-세트).

레이어 세트 액션

/문서/(문서ID)/레이어 세트/(레이어 세트ID)/리콜

지원되는 방법: "GET" "POST"
"(LayerSetID)"로 지정된 레이어 세트를 호출(활성화)하여 모든 레이어가 레이어 세트에 기록된 라이브 상태를 취하도록 합니다.
리콜 후, 즉 "active == true"로 설정된 레이어를 반환합니다.

데이터 저장소

/문서/(문서ID)/데이터스토어/(스토어ID)

지원되는 방법: "GET", "PUT", "삭제"
미모라이브는 사용자가 제공한 데이터를 문서 파일 안에 저장하는 기능을 제공합니다(예: 나중에 상태를 복원하기 위해). "StoreID"는 자유롭게 선택할 수 있지만 문서와 관련된 모든 데이터 저장소를 나열할 수 있는 방법은 없다는 점에 유의하세요(단, 일종의 색인 스토어가 다른 동적으로 명명된 스토어를 추적합니다).

데이터 저장소 생성/업데이트

데이터 저장소를 만들거나 업데이트하려면 "PUT" 요청을 요청 본문에 관련 데이터와 함께 선택한 "StoreID"로 전송합니다. 작업이 성공하면 미모라이브는 "200 OK" 상태로 응답합니다.

데이터 저장소의 콘텐츠 읽기

이전에 저장된 데이터 저장소를 읽으려면 "GET". 데이터는 "PUT"를 요청하여 저장합니다. 이 문서에 대해 해당 ID를 가진 데이터 저장소를 찾을 수 없는 경우 mimoLive는 "404 찾을 수 없음" 오류를 반환합니다.

기존 데이터 저장소 삭제

데이터 저장소가 더 이상 필요하지 않을 때 삭제하려면 "삭제"를 입력해 삭제하려는 'StoreID'를 요청하세요. 데이터 저장소가 애초에 존재하지 않는 경우 mimoLive는 "404 찾을 수 없음" 오류로 응답합니다.

Zoom 미팅

이러한 엔드포인트는 mimoLive에 내장된 Zoom 클라이언트 통합을 제어합니다.

/zoom/join

지원되는 메서드: "GET" "POST"
Zoom 미팅에 참가합니다. 일반적인 매개변수(POST의 경우 JSON 본문으로 전송하거나 GET의 경우 ?param=value로 전송):

연결 진행률 또는 성공 여부를 나타내는 상태 객체를 반환합니다.

/zoom/leave

지원되는 메서드: "GET" "POST"
현재 참가 중인 미팅을 종료합니다. 상태 객체를 반환합니다.

/zoom/end

지원되는 메서드: "GET" "POST"
현재 Zoom 미팅을 종료/종료하려고 시도합니다(호스트 전용 작업). 미팅이 종료된 경우 성공, 클라이언트에 권한이 없는 경우 충돌을 반환합니다.

/zoom/참가자

지원되는 메서드: "GET" "POST"
참여한 미팅의 현재 참가자 목록(이름, ID 및 기본 상태)을 반환합니다.

/zoom/meetingaction

미팅 범위 액션을 실행합니다. JSON 본문 또는 쿼리 문자열을 통해 작업 및 선택적 인수를 제공하세요.

사용 예

mimoLive HTTP API의 엔드포인트는 다양한 방식으로 활용될 수 있습니다. 자세한 내용은 API 사용 예시 섹션을 참조하세요.