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".

/perangkat

Metode yang didukung: "GET"Mengembalikan daftar perangkat video yang saat ini tersedia pada sistem host. Setiap entri berisi pengenal dan nama yang dapat dibaca manusia. Berguna untuk memetakan perangkat perekam ke Sumber.

/perangkat/(DeviceID)

Metode yang didukung: "GET"Mengembalikan detail untuk perangkat yang ditentukan oleh "(DeviceID)", termasuk nama dan propertinya.

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.

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

Metode yang didukung: "GET" "POST" Memilih varian sebelumnya (kebalikan dari /cycleThroughVariants) tanpa memengaruhi kondisi aktif saat ini. Efek akan terlihat saat layer atau varian yang dipilih diatur aktif.

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

Metode yang didukung: "GET" "POST" Mengaktifkan varian pertama dari layer dan membuat layer tersebut hidup.

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

Metode yang didukung: "GET" "POST" Mengaktifkan varian terakhir dari lapisan dan mengatur lapisan tersebut menjadi aktif.

/documents/(DocumentID)/layers/(LayerID)/inputs/(SourceInputKey)/mediacontrol/(MediaControlCommand)

Metode yang didukung: "GET" "POST"
Mengirimkan perintah kontrol media ke media yang terikat dengan input "(SourceInputKey)" pada layer yang ditentukan. Harap diperhatikan bahwa sumber input adalah pelaporan yang memerintahkan perintah pendukungnya; lihat /documents/(DocumentID)/sources/(SourceID).

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:

/documents/(DocumentID)/sources/(SourceID)/mediacontrol/(MediaControlCommand)

Metode yang didukung: "GET" "POST" Mengontrol pemutaran untuk sumber berkemampuan media (mis., File Media/Daftar Putar). Perintah yang didukung bergantung pada jenis sumber. Lihat /documents/(DocumentID)/layers/(LayerID)/inputs/(SourceInputKey)/mediacontrol/(MediaControlCommand).

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

Metode yang didukung: "GET" Jika sumbernya adalah sumber Tangkap Peramban Web, tindakan ini akan membuka jendela peramban web yang sesuai.

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

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

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

Metode yang didukung: "GET" "POST" Bergabung dengan rapat Zoom. Parameter umum (kirim sebagai badan JSON untuk POST atau ?param=nilai untuk GET):

Mengembalikan objek status yang menunjukkan kemajuan atau keberhasilan koneksi.

/zoom/cuti

Metode yang didukung: "GET" "POST" Meninggalkan rapat yang sedang bergabung. Mengembalikan objek status.

/zoom/end

Metode yang didukung: "GET" "POST"Mencoba mengakhiri/mengakhiri rapat Zoom saat ini (tindakan khusus host). Mengembalikan keberhasilan jika rapat diakhiri atau konflik jika klien tidak memiliki izin.

/zoom/peserta

Metode yang didukung: "GET" "POST" Mengembalikan daftar peserta saat ini untuk rapat yang bergabung (nama, ID, dan status dasar).

/zoom/meetingaction

Mengeksekusi tindakan dalam cakupan rapat. Berikan tindakan dan argumen opsional melalui badan JSON atau string kueri.

Contoh Penggunaan

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