Umum

The APIbila diaktifkan, tersedia di "http://localhost:8989/api/v1". Ini adalah dasar URL yang harus ditambahkan ke setiap metode URL yang tercantum di bawah ini.

Jika sumber daya diperkenalkan setelah peluncuran awal HTTP API, metode ini ditandai dengan tanda Tersedia sejak informasi.

/

Metode yang didukung: "DAPATKAN"
Mengalihkan ke daftar dokumen yang terbuka di "/dokumen".

Dokumen

Menanyakan Dokumen

/dokumen

Metode yang didukung: "DAPATKAN"
Menghasilkan daftar dokumen yang terbuka. Lihat tipe data dokumen tentang informasi apa saja yang terkandung dalam objek yang dikembalikan.

/documents/(DocumentID)

Metode yang didukung: "DAPATKAN"
Mengembalikan satu dokumen yang ditentukan oleh "(DocumentID)". Pada bagian yang disertakan dalam respons, semua objek "layer" yang digunakan oleh dokumen ini dan semua objek "sumber" yang terkandung dalam dokumen ini juga akan dikembalikan (sideload). Lihat tipe data dokumen untuk informasi lebih lanjut tentang data yang dikembalikan.

/documents/(DocumentID)/programOut

Metode yang didukung: "DAPATKAN"
Output program yang saat ini dihasilkan oleh dokumen yang ditentukan oleh "(DocumentID)".
Menggunakan parameter yang sama seperti pratinjau sumber.

Tindakan Dokumen

/documents/(DocumentID)/setLive

Metode yang didukung: "DAPATKAN" "POST"
Memulai tayangan/dokumen dan memicu semua peristiwa terkait. Memanggil ini pada dokumen yang sudah berjalan tidak akan menghasilkan kesalahan. Objek dokumen yang diperbarui akan dikembalikan.

/documents/(DocumentID)/setOff

Metode yang didukung: "DAPATKAN" "POST"
Menghentikan tayangan/dokumen. Memanggil ini pada tayangan yang sudah dihentikan tidak akan menghasilkan kesalahan. Objek dokumen yang diperbarui akan dikembalikan.

Karena dokumen dapat memutuskan untuk tetap berjalan setelah Anda memanggil metode ini, objek layer yang dikembalikan mungkin berada dalam kondisi "mati", bukan "tidak aktif".

/documents/(DocumentID)/toggleLive

Metode yang didukung: "DAPATKAN" "POST"
Mengalihkan acara/dokumen antara hidup dan mati.

Lapisan

Lapisan Querying

/documents/(DocumentID)/layers

Metode yang didukung: "DAPATKAN"
Mengembalikan daftar lapisan untuk dokumen yang ditentukan oleh "(DocumentID)". Untuk informasi tentang objek yang dikembalikan, lihat tipe data lapisan.

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

Metode yang didukung: "DAPATKAN", "PUT"
Mengembalikan satu lapisan yang ditentukan oleh "(LayerID)" dalam dokumen yang ditentukan oleh "(DocumentID)". Pada bagian "disertakan" pada respons, semua objek "varian" yang terkait dengan lapisan ini juga akan dikembalikan (sideload). Lihat tipe data lapisan untuk informasi lebih lanjut tentang data yang dikembalikan. Harap diingat bahwa "nilai-input" dari titik akhir lapisan mencerminkan "nilai-input" dari varian "liveVariant" yang terkait.

Memodifikasi Layer

Metode yang didukung: "DAPATKAN", "PUT"
Untuk mengatur nama layer, volume audio atau nilai input, lakukan perintah "PUT" dengan permintaan JSON objek yang dikodekan ke titik akhir layer. Sebagai alternatif, Anda dapat menggunakan "DAPATKAN" dengan menambahkan permintaan JSON data ke URL dengan tombol "?update=". Dalam kasus ini, tombol JSON data harus URL dikodekan.

Nilai yang tidak ingin Anda ubah harus dikeluarkan dari JSON data. Contoh:

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

Setelah memperbarui nilai, mimoLive akan merespons dengan objek layer yang telah diperbarui. Perlu diingat bahwa tidak semua nilai dapat diterapkan secara instan atau mungkin hanya memiliki efek setelah siklus render berikutnya.

Catatan: Atribut "volume" telah ditambahkan pada mimoLive 5.6 dan diabaikan pada versi sebelumnya atau jika layer tidak memiliki kontrol volume. Nilai akan dipotong menjadi (0, 1), di mana 0 adalah hening dan 1 adalah volume penuh.

Tindakan Lapisan

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

Metode yang didukung: "DAPATKAN" "POST"
Mengaktifkan sebuah layer, ketika ini dipanggil secara langsung pada layer, varian layer yang terakhir dipilih akan digunakan. Memanggil ini pada layer yang sudah aktif tidak akan menghasilkan kesalahan. Objek layer yang diperbarui akan dikembalikan.

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

Metode yang didukung: "DAPATKAN" "POST"
Menonaktifkan sebuah layer. Memanggil ini pada layer yang sudah dinonaktifkan tidak akan menghasilkan kesalahan. Objek layer yang diperbarui akan dikembalikan.

Karena sebuah layer dapat memutuskan untuk melakukan beberapa animasi setelah Anda memanggil metode ini, objek layer yang dikembalikan mungkin dalam keadaan "mati", bukan "tidak aktif".

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

Metode yang didukung: "DAPATKAN" "POST"
Mengalihkan lapisan antara "hidup" dan "mati".

/documents/(DocumentID) /layers/(LayerID) /signals/(SignalID)

Metode yang didukung: "DAPATKAN" "POST"
Memicu sinyal yang ditentukan oleh "(SignalID)" di "varian-live" saat ini atau jika layer tidak aktif di "varian-aktif". Anda bisa mendapatkan "(SignalID)" dari bidang "input-values" pada layer (diidentifikasi dengan akhiran kunci "_TypeSignal").

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

Metode yang didukung: "DAPATKAN" "POST"
Tersedia sejak: mimoLive 5.6
Memilih varian berikutnya setelah varian layer yang sedang aktif "(LayerID)" untuk menjadi varian aktif layer yang baru. Ini dapat digunakan untuk memilih varian (mis. dari Layer Lower Third) yang harus ditayangkan berikutnya.
Memanggil titik akhir ini tidak akan mengganggu pertunjukan Anda jika layer sedang ditayangkan. Efeknya hanya akan muncul ketika layer diatur hidup setelahnya.

Varian

Mengajukan Pertanyaan Variats

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

Metode yang didukung: "DAPATKAN"
Mengembalikan daftar varian untuk layer yang ditentukan oleh "(LayerID)" dan dokumen yang ditentukan oleh "(DocumentID)". Untuk informasi tentang objek yang dikembalikan, lihat tipe data "varian".

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

Metode yang didukung: "DAPATKAN", "PUT"
Mengembalikan varian tunggal yang ditentukan oleh "(VariantID)" dan "(LayerID)" dalam dokumen yang ditentukan oleh "(DocumentID)". Lihat tipe data "varian" untuk informasi lebih lanjut tentang data yang dikembalikan.

Memodifikasi Varian

Untuk mengatur nama varian atau nilai input, lakukan perintah "PUT" dengan permintaan JSON objek yang dikodekan ke titik akhir varian. Nilai yang tidak ingin Anda ubah harus dikecualikan dari JSON Anda "PUT". Contoh:

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

Setelah memperbarui nilai, mimoLive akan merespons dengan objek varian yang telah diperbarui. Perlu diingat bahwa tidak semua nilai dapat diterapkan secara instan atau mungkin hanya memiliki efek setelah siklus render berikutnya.

Tindakan Varian

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

Metode yang didukung: "DAPATKAN" "POST"
Mengaktifkan sebuah varian, jika layer yang memiliki tidak aktif, maka akan dialihkan menjadi aktif juga. Memanggil ini pada varian yang sudah aktif tidak akan menghasilkan kesalahan. Objek varian yang telah diperbarui akan dikembalikan.

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

Metode yang didukung: "DAPATKAN" "POST"
Menonaktifkan varian. Hal ini juga akan menyebabkan lapisan pemilik dimatikan.

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

Metode yang didukung: "DAPATKAN" "POST"
Mengalihkan varian antara hidup dan mati.

/documents/(DocumentID)/layers/(LayerID)/variants/(VariantID)/signals/(SignalID)

Metode yang didukung: "DAPATKAN" "POST"
Memicu sinyal yang ditentukan oleh "(SignalID)" pada varian. Anda bisa mendapatkan "(SignalID)" dari bidang "input-values" pada layer (diidentifikasi dengan akhiran kunci "_TypeSignal").

Sumber

Mengajukan Pertanyaan kepada Sumber

/documents/(DocumentID)/sources

Metode yang didukung: "DAPATKAN"
Mengembalikan daftar sumber untuk dokumen yang ditentukan oleh "(DocumentID)". Untuk informasi tentang objek yang dikembalikan, lihat tipe data "lapisan sumber".

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

Metode yang didukung: "DAPATKAN", "PUT"
Mengembalikan satu sumber yang ditentukan oleh "(SourceID)" dalam dokumen yang ditentukan oleh "(DocumentID)". Pada bagian yang disertakan dalam respons, semua objek "filter" yang terkait dengan sumber ini juga akan dikembalikan (sideload). Lihat tipe data "sumber" untuk informasi lebih lanjut tentang data yang dikembalikan.

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

Metode yang didukung: "DAPATKAN"
Mengembalikan pratinjau grafis dari sumber yang ditentukan oleh "(SourceID)" dalam dokumen yang ditentukan oleh "(DocumentID)". Titik akhir mendukung parameter berikut ini:

Parameter	Default	Deskripsi
format	png	Format pratinjau yang dikembalikan. Nilai yang diizinkan: png, jpeg, mjpeg, mpng
fps	10	Kecepatan bingkai untuk pratinjau gambar bergerak. Hanya berlaku untuk format mjpeg dan mpng. Harap diperhatikan bahwa 1 fps kira-kira sama dengan 1% dari CPU pemanfaatan.
lebar	(lebar dokumen)	Lebar maksimum pratinjau. Gambar akan diperkecil agar sesuai dengan lebar yang diberikan.
tinggi	(lebar dokumen)	Ketinggian maksimum pratinjau. Gambar akan diperkecil agar sesuai dengan ketinggian yang diberikan.

Memodifikasi Sumber

Untuk mengatur nama sumber atau nilai input (hanya jika sumbernya ada, misalnya Sumber Komposisi), lakukan perintah "PUT" dengan permintaan JSON objek yang dikodekan ke titik akhir sumber. Nilai yang tidak ingin Anda ubah harus dikecualikan dari JSON Anda "PUT". Contoh:

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

Atribut "gain" telah ditambahkan pada mimoLive 5.6 dan diabaikan pada versi sebelumnya atau jika sumber tidak memiliki kontrol penguatan. Nilai akan dipotong menjadi (0, 2), di mana 0 adalah hening, 1 adalah default dan 2 kira-kira menggandakan volume.

Tindakan Sumber

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

Metode yang didukung: "DAPATKAN" "POST"
Memicu sinyal yang ditentukan oleh "(SignalID)" pada sumber (hanya jika sumber memiliki "input-values", misalnya, sumber tersebut adalah Sumber Komposisi). Anda bisa mendapatkan "(SignalID)" dari bidang "input-values" pada sumber (diidentifikasi dengan akhiran kunci "_TypeSignal").

Filter

Menanyakan Filter

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

Metode yang didukung: "DAPATKAN"
Mengembalikan daftar filter untuk sumber yang ditentukan oleh "(SourceID)" dan dokumen yang ditentukan oleh "(DocumentID)". Untuk informasi tentang objek yang dikembalikan, lihat tipe data "filter".

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

Metode yang didukung: "DAPATKAN", "PUT"
Mengembalikan satu filter yang ditentukan oleh "(FilterID)" dan "(SourceID)" dalam dokumen yang ditentukan oleh "(DocumentID)". Lihat tipe data "filter" untuk informasi lebih lanjut tentang data yang dikembalikan.

Memodifikasi Filter

Untuk mengatur nilai input, lakukan perintah "PUT" dengan permintaan JSON objek yang dikodekan ke titik akhir filter. Nilai yang tidak ingin Anda ubah harus dikecualikan dari JSON Anda "PUT". Contoh:

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

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

Metode yang didukung: "DAPATKAN" "POST"
Memicu sinyal yang ditentukan oleh "(SignalID)" pada filter. Anda bisa mendapatkan "(SignalID)" dari bidang "input-values" pada filter (diidentifikasi dengan akhiran kunci "_TypeSignal").

Tujuan Keluaran

Menanyakan Tujuan Keluaran

/dokumen/(DocumentID)/tujuan-keluaran

textileRef:9996801466400ba8908856:linkStartMarker:“Metode yang didukung: "DAPATKAN"
Tersedia sejak: mimoLive 4.2
Mencantumkan semua tujuan keluaran untuk dokumen yang ditentukan.
Untuk informasi tentang objek yang dikembalikan, lihat tipe data ""output-tujuan"":{TOPIK-LINK+data-typesh1(}. bagian-tujuan-output).

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

Metode yang didukung: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Tersedia sejak: mimoLive 4.2
Mengembalikan tujuan keluaran yang ditentukan oleh "(OutputDestinationID)".
Untuk informasi tentang objek yang dikembalikan, lihat tipe data ""output-tujuan"":{TOPIK-LINK+data-typesh1(}. bagian-tujuan-output).

Memodifikasi Tujuan Keluaran

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

Metode yang didukung: "PATCH"
Tersedia sejak: mimoLive 4.2
Memperbarui properti yang dipilih dari tujuan keluaran yang ditentukan oleh "(OutputDestinationID)".
Mengembalikan tujuan keluaran yang diperbarui.

Properti berikut ini dapat dimodifikasi:

• "judul"
• "dimulai-dengan-pertunjukan"
• "berhenti-dengan-pertunjukan"
• Isi objek "pengaturan" (lihat bagian deskripsi pengaturan. bagian-pengaturan-individu) untuk informasi lebih lanjut)

Deskripsi pembaruan harus diberikan dalam JSONFormat pembaruan API . pembaruan mentah). Contoh:

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

Tindakan Tujuan Keluaran

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

Metode yang didukung: "DAPATKAN" "POST"
Tersedia sejak: mimoLive 4.2
Menyebabkan tujuan keluaran yang ditentukan oleh "(OutputDestinationID)" untuk ditayangkan, jika dikonfigurasi dengan benar dan diizinkan untuk ditayangkan (mis. berdasarkan status lisensi mimoLive).
Jika tujuan keluaran dapat ditayangkan, tujuan keluaran dengan "kondisi-live" yang baru akan dikembalikan, jika tidak, kesalahan "409 Konflik" akan dikembalikan.

Karena tujuan keluaran mungkin perlu melakukan beberapa pekerjaan sebelum ditayangkan (misalnya menghubungi layanan eksternal untuk membuat siaran langsung), objek tujuan keluaran yang dikembalikan mungkin dalam keadaan "startup", bukan "live".

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

Metode yang didukung: "DAPATKAN" "POST"
Tersedia sejak: mimoLive 4.2
Menyebabkan tujuan output yang ditentukan oleh "(OutputDestinationID)" berhenti.
Jika tujuan output diizinkan untuk berhenti, tujuan output dikembalikan, jika tidak, kesalahan "409 Konflik" dikembalikan.

Karena tujuan output mungkin perlu melakukan beberapa pekerjaan sebelum menghentikan operasi, tujuan output yang dikembalikan mungkin dalam keadaan "shutdown" alih-alih "preview" (yang akan menjadi default untuk tujuan output yang dikonfigurasi dengan baik).

Set Lapisan

Layer set diperkenalkan di mimoLive 5.0 dan memungkinkan pengaturan status live dari beberapa layer sekaligus, sehingga memungkinkan pembuatan adegan untuk situasi yang berbeda dalam sebuah pertunjukan. Mereka hanya dapat dibuat dan diubah di mimoLive. API akses dibatasi untuk mendapatkan dan mengingat (mengaktifkan) set lapisan.

Mengajukan Pertanyaan Kumpulan Lapisan

/documents/(DocumentID)/layer-sets

textileRef:9996801466400ba8908856:linkStartMarker:“Metode yang didukung: "DAPATKAN"
Tersedia sejak: mimoLive 5.0
Mencantumkan semua set layer untuk dokumen yang ditentukan.
Untuk informasi tentang objek yang dikembalikan, lihat tipe data ""layer-set"":{TOPIK-LINK+data-typesh1(}. section-layer-sets).

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

Metode yang didukung: “GETtextileRef:9996801466400ba8908856:linkStartMarker:”
Tersedia sejak: mimoLive 5.0
Mengembalikan set layer yang ditentukan oleh "(LayerSetID)".
Untuk informasi tentang objek yang dikembalikan, lihat tipe data ""layer-set"":{TOPIK-LINK+data-typesh1(}. section-layer-sets).

Tindakan Pengaturan Lapisan

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

Metode yang didukung: "DAPATKAN" "POST"
Tersedia sejak: mimoLive 5.0
Memanggil kembali (mengaktifkan) set layer yang ditentukan oleh "(LayerSetID)", menyebabkan semua layer mengasumsikan status live yang direkam dalam set layer.
Mengembalikan set layer setelah dipanggil kembali, yaitu dengan "active == true".

Penyimpanan Data

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

Metode yang didukung: "DAPATKAN", "PUT", "MENGHAPUS"
mimoLive menawarkan kemampuan untuk menyimpan data yang Anda berikan di dalam file dokumen, misalnya untuk memulihkan keadaan di lain waktu. Anda bebas memilih sendiri "StoreID", tetapi perlu diketahui bahwa tidak ada cara untuk membuat daftar semua penyimpanan data yang terkait dengan sebuah dokumen (namun, Anda dapat membuat semacam indeks yang melacak toko Anda yang lain, yang dinamai secara dinamis).

Membuat/Memperbaharui penyimpanan data

Untuk membuat atau memperbarui penyimpanan data, kirimkan pesan "PUT" ke "StoreID" pilihan Anda dengan data terkait di dalam isi permintaan Anda. Jika operasi berhasil, mimoLive akan merespons dengan status "200 OK".

Membaca isi penyimpanan data

Untuk membaca data yang disimpan sebelumnya, cukup minta melalui "DAPATKAN". Data akan dikembalikan persis seperti yang Anda berikan di bagian "PUT" untuk menyimpannya. Jika tidak ada penyimpanan data dengan ID tersebut yang ditemukan untuk dokumen ini, mimoLive akan mengembalikan kesalahan "404 Tidak Ditemukan".

Menghapus penyimpanan data yang ada

Untuk menghapus penyimpanan data ketika Anda tidak lagi membutuhkannya, cukup keluarkan perintah "MENGHAPUS" untuk "StoreID" yang ingin Anda hapus. Jika penyimpanan data tidak ada di sana, mimoLive akan merespons dengan kesalahan "404 Tidak Ditemukan".

Contoh Penggunaan

Titik akhir API HTTP mimoLive ini dapat digunakan dengan berbagai cara. Silakan lihat bagian Contoh Penggunaan API untuk mempelajari lebih lanjut.