Генерал

У "The APIколи вона увімкнена, доступна за адресою "http://localhost:8989/api/v1". Це база URL які повинні додаватися до кожного методу URL перераховані нижче.

Якщо ресурс було введено після початкового запуску HTTP APIметод позначається символом Доступно з інформацію.

/

Підтримувані методи: "GET"
Перенаправляє до списку відкритих документів за адресою "/documents".

Документи

Запит на документи

/documents

Підтримувані методи: "GET"
Повертає список відкритих документів. Яку інформацію містять повернуті об'єкти, дивіться в типі даних документів.

/documents/(DocumentID)

Підтримувані методи: "GET"
Повертає один документ, визначений за допомогою параметра "(DocumentID)". У включеній секції відповіді будуть також повернуті всі об'єкти "шару", що використовуються цим документом, і всі об'єкти "джерела", що містяться в цьому документі (бічне завантаження). Дивіться тип даних документа для отримання додаткової інформації про дані, що повертаються.

/documents/(DocumentID)/programOut

Підтримувані методи: "GET"
Вихідні дані програми, які в даний момент генеруються документом, визначеним за допомогою "(DocumentID)".
Приймає ті самі параметри, що й попередній перегляд джерела.

Документ Дії

/documents/(DocumentID)/setLive

Підтримувані методи: "GET" "POST"
Запускає шоу/документ і запускає всі пов'язані з ним події. Виклик цієї команди на вже запущеному документі не призведе до помилки. Буде повернуто оновлений об'єкт документа.

/documents/(DocumentID)/setOff

Підтримувані методи: "GET" "POST"
Зупиняє шоу/документ. Виклик цієї команди на вже зупиненому шоу не призведе до помилки. Буде повернуто оновлений об'єкт документа.

Оскільки документ може вирішити продовжити виконання після виклику цього методу, об'єкт шару, що повертається, може перебувати у стані "вимкнено", а не "вимкнено".

/documents/(DocumentID)/toggleLive

Підтримувані методи: "GET" "POST"
Перемикає шоу/документ між режимами "живий" і "вимкнений".

Шари

Шари запитів

/documents/(DocumentID)/layers

Підтримувані методи: "GET"
Повертає список шарів для документа, визначеного за допомогою "(DocumentID)". Інформацію про об'єкти, що повертаються, дивіться у типі даних layers.

/documents/(DocumentID)/layers/(LayerID)

Підтримувані методи: "GET", "PUT"
Повертає один шар, вказаний за допомогою "(LayerID)" у документі, вказаному за допомогою "(DocumentID)". У секції "включено" відповіді будуть повернуті також усі "варіантні" об'єкти, пов'язані з цим шаром (бічне завантаження). Дивіться тип даних шару для отримання додаткової інформації про дані, що повертаються. Будь ласка, майте на увазі, що "вхідні значення" з кінцевої точки шару відображають "вхідні значення" пов'язаного з ним варіанту "liveVariant".

Модифікація шару

Підтримувані методи: "GET", "PUT"
Щоб задати назву шару, гучність звуку або значення входу, виконайте команду "PUT" запит з параметром JSON кодований об'єкт до кінцевої точки шару. Альтернативно, ви можете використовувати "GET" запит, додавши JSON дані до URL з ключем "?update=". У цьому випадку JSON дані повинні бути URL закодовані.

Цінності, які ви не хочете змінювати, слід просто виключити з JSON дані. Приклад:

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

Після оновлення значень mimoLive відповість оновленим об'єктом шару. Майте на увазі, що не всі значення можуть бути застосовані миттєво або мати ефект лише після наступного циклу рендеру.

Примітка: Атрибут "volume" було додано у mimoLive 5.6, у попередніх версіях він ігнорується або якщо шар не має регулятора гучності. Значення буде обрізано до (0, 1), де 0 - тиша, а 1 - повна гучність.

Дії з шарами

/documents/(DocumentID)/layers/(LayerID)/setLive

Підтримувані методи: "GET" "POST"
Активує шар, коли цю команду викликано безпосередньо на шарі, буде використано останній вибраний варіант шару. Виклик цієї команди на вже активному шарі не призведе до помилки. Буде повернуто оновлений об'єкт шару.

/documents/(DocumentID)/layers/(LayerID)/setOff

Підтримувані методи: "GET" "POST"
Деактивує шар. Виклик цієї команди на вже деактивованому шарі не призведе до помилки. Буде повернуто оновлений об'єкт шару.

Оскільки шар може вирішити виконати анімацію після виклику цього методу, об'єкт шару, що повертається, може перебувати у стані "вимкнено", а не "вимкнено".

/documents/(DocumentID)/layers/(LayerID)/toggleLive

Підтримувані методи: "GET" "POST"
Перемикає шар між "живим" і "вимкненим".

/documents/(DocumentID)/шари/(LayerID)/сигнали/(SignalID)

Підтримувані методи: "GET" "POST"
Спрацьовує на сигнал, визначений "(SignalID)" у поточному "live-варіанті" або, якщо шар не є живим, у "active-варіанті". Ви можете отримати "(SignalID)" з поля "input-values" шару (ідентифікується за ключовим суфіксом "_TypeSignal").

/documents/(DocumentID)/layers/(LayerID)/cycleThroughVariants

Підтримувані методи: "GET" "POST"
Доступно починаючи з: mimoLive 5.6
Вибирає наступний варіант після поточного активного варіанта шару "(LayerID)", щоб стати новим активним варіантом шару. Це може бути використано для вибору варіанта (наприклад, шару Lower Third), який має стати активним наступний.
Виклик цієї кінцевої точки не заважає вашому шоу, якщо шар наразі перебуває в режимі реального часу. Ефект з'являється лише тоді, коли шар стає живим після цього.

Варіанти

Запити до варіацій

/documents/(DocumentID)/шари/(LayerID)/варіанти

Підтримувані методи: "GET"
Повертає список варіантів для шару, вказаного за допомогою "(LayerID)" та документа, вказаного за допомогою "(DocumentID)". Інформацію про об'єкти, що повертаються, дивіться в описі типу даних "variants".

/documents/(DocumentID)/шари/(LayerID)/варіанти/(VariantID)

Підтримувані методи: "GET", "PUT"
Повертає один варіант, вказаний за допомогою "(VariantID)" та "(LayerID)" у документі, вказаному за допомогою "(DocumentID)". Дивіться тип даних "variants" для отримання додаткової інформації про дані, що повертаються.

Модифікація варіанту

Щоб задати назву варіанту або вхідні значення, виконайте команду "PUT" запит з параметром JSON кодованого об'єкта до кінцевої точки варіанту. Значення, які ви не хочете змінювати, слід просто виключити з JSON ти.PUT". Приклад:

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

Після оновлення значень mimoLive відповість оновленим об'єктом-варіантом. Майте на увазі, що не всі значення можуть бути застосовані миттєво або мати ефект лише після наступного циклу рендеру.

Варіанти дій

/documents/(DocumentID)/layers/(LayerID)/variants/(VariantID)/setLive

Підтримувані методи: "GET" "POST"
Активує варіант, якщо власний шар не є активним, він також буде переключений на активний. Виклик цієї команди на вже активному варіанті не призведе до помилки. Буде повернуто оновлений об'єкт варіанта.

/documents/(DocumentID)/layers/(LayerID)/variants/(VariantID)/setOff

Підтримувані методи: "GET" "POST"
Деактивує варіант. Це також призведе до вимкнення шару-власника.

/documents/(DocumentID)/layers/(LayerID)/variants/(VariantID)/toggleLive

Підтримувані методи: "GET" "POST"
Перемикає варіант між "живим" і "вимкненим".

/documents/(DocumentID)/шари/(LayerID)/варіанти/(VariantID)/сигнали/(SignalID)

Підтримувані методи: "GET" "POST"
Спрацьовує на сигнал, визначений "(SignalID)" на варіанті. Ви можете отримати "(SignalID)" з поля "input-values" шару (ідентифікується за ключовим суфіксом "_TypeSignal").

Джерела

Запити до джерел

/documents/(DocumentID)/sources

Підтримувані методи: "GET"
Повертає список джерел для документа, визначеного за допомогою "(DocumentID)". Інформацію про об'єкти, що повертаються, див. у типі даних "sources layer".

/documents/(DocumentID)/sources/(SourceID)

Підтримувані методи: "GET", "PUT"
Повертає єдине джерело, вказане за допомогою "(SourceID)" у документі, вказаному за допомогою "(DocumentID)". У включеній секції відповіді також будуть повернуті всі об'єкти "фільтра", пов'язані з цим джерелом (бічне завантаження). Дивіться тип даних "sources" для отримання додаткової інформації про дані, що повертаються.

/documents/(DocumentID)/sources/(SourceID)/preview

Підтримувані методи: "GET"
Повертає графічний прев'ю джерела, вказаного за допомогою "(SourceID)", у документі, вказаному за допомогою "(DocumentID)". Кінцева точка підтримує наступні параметри:

Параметр	За замовчуванням	Опис
формат	png	Формат, у якому повертається прев'ю. Допустимі значення: png, jpeg, mjpeg, mpng
fps	10	Частота кадрів для попереднього перегляду зображень у русі. Застосовується лише для форматів mjpeg та mpng. Зверніть увагу, що 1 кадр/с приблизно дорівнює 1% з ПРОЦЕСОР утилізація.
ширина	(ширина документа)	Максимальна ширина попереднього перегляду. Зображення буде зменшено до заданої ширини.
висота	(ширина документа)	Максимальна висота попереднього перегляду. Зображення буде зменшено до заданої висоти.

Модифікація джерела

Щоб задати ім'я джерела або вхідних значень (тільки якщо джерело має такі, наприклад, якщо це Джерело Композиції), виконайте команду "PUT" запит з параметром JSON кодованого об'єкта до кінцевої точки джерела. Значення, які ви не хочете змінювати, слід просто виключити зі списку JSON ти.PUT". Приклад:

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

Атрибут "gain" було додано у mimoLive 5.6, він ігнорується у попередніх версіях або якщо джерело не має регулятора гучності. Значення буде обрізано до (0, 2), де 0 - тихий звук, 1 - за замовчуванням, а 2 - приблизно подвоює гучність.

Джерело Дії

/documents/(DocumentID)/sources/(SourceID)/signals/(SignalID)

Підтримувані методи: "GET" "POST"
Запускає сигнал, визначений "(SignalID)" на джерелі (тільки якщо джерело має "input-values", тобто є джерелом композиції). Ви можете отримати "(SignalID)" з поля "input-values" джерела (ідентифікується за ключовим суфіксом "_TypeSignal").

Фільтри

Фільтри запитів

/documents/(DocumentID)/sources/(SourceID)/filters

Підтримувані методи: "GET"
Повертає список фільтрів для джерела, вказаного через "(SourceID)", і документа, вказаного через "(DocumentID)". Для отримання інформації про об'єкти, що повертаються, дивіться тип даних "filters".

/documents/(DocumentID)/sources/(SourceID)/filters/(FilterID)

Підтримувані методи: "GET", "PUT"
Повертає один фільтр, визначений за допомогою "(FilterID)" та "(SourceID)" у документі, визначеному за допомогою "(DocumentID)". Дивіться тип даних "filters" для отримання додаткової інформації про дані, що повертаються.

Зміна фільтра

Щоб задати вхідні значення, виконайте команду "PUT" запит з параметром JSON кодованого об'єкта до кінцевої точки фільтра. Значення, які ви не хочете змінювати, слід просто виключити зі списку JSON ти.PUT". Приклад:

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

/documents/(DocumentID)/sources/(SourceID)/filters/(FilterID)/signals/(SignalID)

Підтримувані методи: "GET" "POST"
Спрацьовує на сигнал, визначений "(SignalID)" на фільтрі. Ви можете отримати "(SignalID)" з поля "input-values" фільтра (ідентифікується за ключовим суфіксом "_TypeSignal").

Пункти призначення на виході

Запити до пунктів призначення виводу

/documents/(DocumentID)/output-destinations

textileRef:9996801466400ba8908856:linkStartMarker:“Підтримувані методи: "GET"
Доступно починаючи з: mimoLive 4.2
Перераховує всі пункти призначення виводу для вказаного документа.
Інформацію про об'єкти, що повертаються, дивіться в типі даних ""output-destinations"":{TOPIC-ПОСИЛАННЯ+data-typesh1(}. section-output-destinations).

/documents/(DocumentID)/output-destinations/(OutputDestinationID)

Підтримувані методи: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Доступно починаючи з: mimoLive 4.2
Повертає місце призначення виводу, вказане в "(OutputDestinationID)".
Інформацію про об'єкти, що повертаються, дивіться в типі даних ""output-destinations"":{TOPIC-ПОСИЛАННЯ+data-typesh1(}. section-output-destinations).

Зміна місця призначення виводу

/documents/(DocumentID)/output-destinations/(OutputDestinationID)

Підтримувані методи: "ВИПРАВЛЕННЯ"
Доступно починаючи з: mimoLive 4.2
Оновити вибрані властивості місця призначення виводу, вказані за допомогою "(OutputDestinationID)".
Повертає оновлене місце призначення виводу.

Наступні властивості можна змінювати:

• "title"
• "починається з шоу"
• "зупинки з показом"
• Вміст об'єкту "settings" (див. розділ опис налаштувань. section-individual-settings) для отримання додаткової інформації)

Опис оновлення має бути поданий у вигляді JSONФормат оновлення API . грубе оновлення). Приклад:

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

Дії призначення виводу

/documents/(DocumentID)/output-destinations/(OutputDestinationID)/setLive

Підтримувані методи: "GET" "POST"
Доступно починаючи з: mimoLive 4.2
Спричиняє запуск місця призначення виводу, вказаного в "(OutputDestinationID)", якщо його правильно налаштовано і дозволено до запуску (наприклад, на основі стану ліцензування mimoLive).
Якщо вихідний пункт призначення може працювати, повертається вихідний пункт призначення з його новим "live-станом", інакше повертається помилка "409 Конфлікт".

Оскільки об'єкт призначення може потребувати виконання певної роботи перед тим, як стати живим (наприклад, зв'язок із зовнішнім сервісом для створення живого потоку), повернутий об'єкт призначення може перебувати у стані "запуску" замість "живого".

/documents/(DocumentID)/output-destinations/(OutputDestinationID)/setOff

Підтримувані методи: "GET" "POST"
Доступно починаючи з: mimoLive 4.2
Зупиняє місце призначення виводу, вказане у "(OutputDestinationID)".
Якщо пункт призначення дозволено зупинити, повертається пункт призначення, інакше повертається помилка "409 Конфлікт".

Оскільки пункт призначення виводу може потребувати виконання певної роботи перед зупинкою операцій, повернутий пункт призначення виводу може перебувати у стані "вимкнення" замість "попереднього перегляду" (який буде за замовчуванням для добре налаштованого пункту призначення виводу).

Набори шарів

Набори шарів з'явилися в mimoLive 5.0 і дозволяють встановлювати живий стан одразу для декількох шарів, що дає змогу створювати легкі сцени для різних ситуацій у шоу. Їх можна створювати і змінювати тільки в mimoLive. API доступ обмежений для отримання та згадуючи (активуючі) набори шарів.

Запити до наборів шарів

/documents/(DocumentID)/layer-sets

textileRef:9996801466400ba8908856:linkStartMarker:“Підтримувані методи: "GET"
Доступно з: mimoLive 5.0
Перелічує всі набори шарів для вказаного документа.
Інформацію про повернуті об'єкти дивіться в типі даних ""layer-sets"":{TOPIC-ПОСИЛАННЯ+data-typesh1(}. section-layer-sets).

/documents/(DocumentID)/layer-sets/(LayerSetID)

Підтримувані методи: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Доступно з: mimoLive 5.0
Повертає набір шарів, заданий параметром "(LayerSetID)".
Інформацію про повернуті об'єкти дивіться в типі даних ""layer-sets"":{TOPIC-ПОСИЛАННЯ+data-typesh1(}. section-layer-sets).

Дії з набором шарів

/documents/(DocumentID)/layer-sets/(LayerSetID)/recall

Підтримувані методи: "GET" "POST"
Доступно з: mimoLive 5.0
Викликає (активує) набір шарів, вказаний за допомогою "(LayerSetID)", в результаті чого всі шари приймають стан, записаний у наборі шарів.
Повертає шар, встановлений після виклику, тобто з "active == true".

Сховища даних

/documents/(DocumentID)/datastores/(StoreID)

Підтримувані методи: "GET", "PUT", "ВИДАЛИТИ"
mimoLive пропонує можливість зберігати дані, які ви надаєте, у файлі документа, наприклад, щоб відновити стан пізніше. Ви можете самостійно вибрати "StoreID", але майте на увазі, що не існує способу перерахувати всі сховища даних, пов'язані з документом (однак, ви можете створити певний тип індекс який відстежує інші ваші магазини з динамічними іменами).

Створення/оновлення сховища даних

Щоб створити або оновити сховище даних, надішліть "PUT" до "StoreID" за вашим вибором з відповідними даними в тілі запиту. Якщо операція пройшла успішно, mimoLive відповість статусом "200 OK".

Читання вмісту сховища даних

Щоб прочитати раніше збережене сховище даних, просто запитайте його через "GET". Дані будуть повернуті в тому вигляді, в якому ви вказали їх у полі "PUT" запит на його збереження. Якщо для цього документа не знайдено сховища даних з таким ідентифікатором, mimoLive поверне помилку "404 Не знайдено".

Видалення існуючого сховища даних

Щоб видалити сховище даних, коли воно вам більше не потрібне, просто видайте команду "ВИДАЛИТИ" для "StoreID", який ви хочете видалити. У випадку, якщо сховища даних не існувало з самого початку, mimoLive відповість помилкою "404 Не знайдено".

Приклад використання

Ці кінцеві точки HTTP API mimoLive можна використовувати різними способами. Будь ласка, зверніться до розділу Приклади використання API, щоб дізнатися більше.