Modul DCV - Amazon DCV
MetodeAnggotaDefinisi tipe dan panggilan balik

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Modul DCV

Modul yang mengimplementasikan sisi klien DCV protokol.

Metode

otentikasi (url, panggilan balik) → {Otentikasi}

Memulai proses otentikasi untuk endpoint DCV server Amazon yang ditentukan.

Parameter:

Nama Tipe Deskripsi
url string Nama host dan port DCV server Amazon yang sedang berjalan dalam format berikut:https://dcv_host_address:port. Sebagai contoh: https://my-dcv-server:8443.
callbacks authenticationCallbacks Callback yang tersedia untuk dipanggil selama proses otentikasi.

Pengembalian:

- Objek Otentikasi.

Tipe

Autentikasi

sambungkan (konfigurasi) → {Janji. < Koneksi >|Janji. < {code: ConnectionErrorCode, pesan: string} >}

Terhubung ke titik akhir DCV server Amazon yang ditentukan. Jika koneksi berhasil, ia mengembalikan objek Connection. Jika koneksi gagal, ia mengembalikan objek kesalahan.

Parameter:

Nama Tipe Deskripsi
config ConnectionConfig ConnectionConfig Objeknya.

Pengembalian:

- Sebuah objek Connection, atau objek kesalahan.

Tipe

Janji. < Koneksi > | Janji. < {code: ConnectionErrorCode, pesan: string} >

setLogHandler(handler) → {void}

Menetapkan fungsi penangan log kustom. Saat mengganti penangan log default, posisi entri log asli akan hilang saat debugging dengan konsol browser.

Parameter:

Nama Tipe Deskripsi
handler Fungsi Fungsi penangan log kustom. Fungsi handler berisi level (number), levelName (string), domain (string), dan message (string).

Pengembalian:

Tipe

kosong

setLogLevel(tingkat) → {void}

Mengatur level log. Ini diperlukan hanya jika penangan log default digunakan.

Parameter:

Nama Tipe Deskripsi
level LogLevel Level log yang akan digunakan.

Pengembalian:

Tipe

kosong

Anggota

(konstan) AudioError: AudioErrorCode

AudioError Kode enum.

Jenis:

(konstan) AuthenticationError: AuthenticationErrorCode

AuthenticationError Kode enum.

Jenis:

(konstan) ChannelError: ChannelErrorCode

ChannelError Kode enum.

Jenis:

(konstan) ClosingReasonError: ClosingReasonErrorCode

ClosingReasonError Kode enum.

Jenis:

(konstan) ConnectionError: ConnectionErrorCode

ConnectionError Kode enum.

Jenis:

(konstan) CustomChannelError: CustomChannelErrorCode

CustomChannelError Kode enum.

Jenis:

(konstan) DisplayConfigError: DisplayConfigErrorCode

DisplayConfigError Kode enum.

Jenis:

(konstan) FileStorageError: FileStorageErrorCode

FileStorageError Kode enum.

Jenis:

(konstan) LogLevel: LogLevel

Level SDK log yang tersedia.

Jenis:

(konstan) MultiMonitorError: MultiMonitorErrorCode

MultiMonitorError Kode enum.

Jenis:

(konstan) ResolutionError: ResolutionErrorCode

ResolutionError Kode enum.

Jenis:

(konstan) TimezoneRedirectionError: TimezoneRedirectionErrorCode

TimezoneRedirectionError Kode enum.

Jenis:

(konstan) TimezoneRedirectionSetting: TimezoneRedirectionSettingCode

TimezoneRedirectionSetting Kode enum.

Jenis:

(konstan) TimezoneRedirectionStatus: TimezoneRedirectionStatusCode

TimezoneRedirectionStatus Kode enum.

Jenis:

versi (konstan)

DCVVersi Amazon dengan mayor, minor, patch, revisi, diperpanjang, danversionStr.

Properti:

Nama Tipe Deskripsi
major Integer Nomor versi utama.
minor integer Nomor versi minor.
patch integer Nomor versi patch.
revision integer Nomor revisi.
extended string String yang diperpanjang.
versionStr string Penggabungan nomor mayor, minor, patch, dan revisi dalam formulir. major.minor.patch+build.revision

(konstan) ScreenshotError: ScreenshotErrorCode

ScreenshotError Kode enum.

Jenis:

(konstan) WebcamError: WebcamErrorCode

WebcamError Kode enum.

Jenis:

Definisi tipe dan panggilan balik

AudioErrorCode

Enum AudioError kode tersedia dalam modul DCV

  • SETTING_AUDIO_FAILED

  • CHANNEL_NOT_AVAILABLE

Jenis:

  • number

authenticationCallbacks

Callback otentikasi

Jenis:

  • Objek

Properti:

Nama Tipe Deskripsi
promptCredentials authPromptCredentialsCallback Fungsi callback yang akan dipanggil ketika pengguna ditantang untuk kredensyal.
error authErrorCallback Fungsi callback yang akan dipanggil ketika otentikasi gagal.
success authSuccessCallback Fungsi callback yang akan dipanggil ketika otentikasi berhasil.

AuthenticationErrorCode

Enum AuthenticationError kode tersedia dalam modul DCV

  • INVALID_MESSAGE

  • UNKNOWN_AUTH_MODE

  • SESSION_NOT_AVAILABLE

  • NO_SESSIONS

  • WRONG_CREDENTIALS

  • SASL_CHALLENGE

  • SASL_AUTH_MECHANISM

  • FAILED_COMMUNICATION

  • AUTHENTICATION_REJECTED

  • GENERIC_ERROR

  • WRONG_CREDENTIALS_FORMAT

  • WRONG_CREDENTIALS_TYPE

  • UNREQUESTED_CREDENTIALS

  • MISSING_CREDENTIAL

Jenis:

  • number

authErrorCallback(otentikasi, kesalahan)

Fungsi callback yang akan dipanggil ketika otentikasi gagal.

Parameter:

Nama Tipe Deskripsi
authentication Autentikasi Objek otentikasi.
error Objek Objek kesalahan yang dimunculkan oleh proses otentikasi.
Nama Tipe Deskripsi
code AuthenticationErrorCode Kode kesalahan.
message string Pesan kesalahan.

authPromptCredentialsCallback (otentikasi, tantangan)

Fungsi callback yang akan dipanggil ketika pengguna ditantang untuk kredensyal. Pengguna harus menjawab tantangan dengan memberikan kredensyal yang diminta.

Parameter:

Nama Tipe Deskripsi
authentication Autentikasi Objek otentikasi.
challenge Objek Tantangannya.
Nama Tipe Deskripsi
requiredCredentials Array. <Object> Array objek kredensi yang diminta.
Nama Tipe Deskripsi
name string Nama kredensi yang diminta.
type string Jenis kredensi yang diminta.

authSuccessCallback(otentikasi,authenticationData)

Fungsi callback yang akan dipanggil ketika otentikasi berhasil.

Parameter:

Nama Tipe Deskripsi
authentication Autentikasi Objek otentikasi.
authenticationData Array. <Object> Array objek yang mencakup DCV sesi Amazon IDs dan token otentikasi.
Nama Tipe Deskripsi
sessionId string ID DCV sesi Amazon.
authToken string Token otentikasi untuk DCV sesi Amazon.

Channel

Saluran yang tersedia yang dapat ditentukan.

Jenis:

  • “clipboard” | “tampilan” | “masukan” | “audio” | “penyimpanan file”

ChannelErrorCode

Enum ChannelError kode tersedia dalam modul DCV

  • ALREADY_OPEN

  • INITIALIZATION_FAILED

  • REJECTED

Jenis:

  • number

clipboardEventCallback(acara)

Fungsi callback yang akan dipanggil ketika a clipboardEvent dihasilkan.

Parameter:

Nama Tipe Deskripsi
event Objek Informasi tentang acara clipboard.
Nama Tipe Atribut Deskripsi
name didirikan | salin | tempel dataSizeAlert | autoCopyDone | newDataAvailable | autoPasteDone | remoteError | pasteAvailableData Selalu hadir. Nama peristiwa.
clipboardData Objek | string Data di clipboard.
autoCopy boolean <optional> Menunjukkan apakah penyalinan otomatis dari clipboard sesi ke clipboard klien lokal diaktifkan.
maxDataSize number <optional> Jumlah maksimum data yang dapat ditempatkan di clipboard.
error string <optional> Informasi kesalahan jika berlaku.

ClosingReasonErrorCode

Enum ClosingReasonError kode tersedia dalam modul DCV

  • TRANSPORT_ERROR

  • NO_ERROR

  • GENERIC_ERROR

  • INTERNAL_SERVER_ERROR

  • PROTOCOL_ERROR

  • AUTHORIZATION_DENIED

  • AUTHORIZATION_REVOKED

  • ACCESS_REJECTED

  • IDLE_TIMEOUT_EXPIRED

  • DISCONNECT_BY_OWNER

  • DISCONNECT_BY_USER

  • EVICTED

  • EXTERNAL_PROTOCOL_CONNECTION_EVICTED

  • DISCONNECTION_REQUESTED

Jenis:

  • number

Ruang Warna

Ruang warna yang tersedia yang dapat ditentukan.

Jenis:

  • “RGB" | "YUV_ REC6 01" |" YUV _ REC7 09"

connectionCallbacks

Callback yang tersedia untuk dipanggil jika terjadi kesalahan koneksi.

Jenis:

  • Objek

Properti:

Nama Tipe Deskripsi
disconnect disconnectCallback Fungsi callback yang akan dipanggil ketika koneksi berakhir.
displayLayout displayLayoutCallback Fungsi callback yang akan dipanggil ketika tata letak tampilan atau resolusi diubah.
displayAvailability displayAvailabilityCallback Fungsi callback yang akan dipanggil saat ketersediaan tampilan berubah.
firstFrame firstFrameCallback Fungsi callback yang akan dipanggil ketika frame pertama diterima dari DCV server Amazon.
filePrinted filePrintedCallback Fungsi callback yang akan dipanggil ketika file dicetak di DCV server Amazon.
fileDownload fileDownloadCallback Fungsi callback yang akan dipanggil ketika file siap diunduh dari DCV server Amazon.
dataChannel dataChannelCallback Fungsi callback yang akan dipanggil ketika DCV server Amazon mengirimkan pemberitahuan tentang ketersediaan saluran data.
licenseNotification licenseNotificationCallback Fungsi callback yang akan dipanggil ketika DCV server Amazon mengirimkan pemberitahuan tentang status lisensi.
idleWarningNotification idleWarningNotificationCallback Fungsi callback yang akan dipanggil saat DCV server Amazon mengirimkan peringatan batas waktu idle.
collaboratorList collaboratorListCallback Fungsi callback yang akan dipanggil ketika DCV server Amazon mengirimkan daftar kolaborator (sejak Amazon DCV Web Client SDK versi 1.1.0).
qualityIndicatorState qualityIndicatorStateCallback Fungsi callback yang akan dipanggil ketika indikator kualitas koneksi berubah status.
filestorageEnabled filestorageEnabledCallback Fungsi callback yang akan dipanggil ketika penyimpanan file diaktifkan atau dinonaktifkan.
featuresUpdate featuresUpdateCallback Fungsi callback yang akan dipanggil ketika status fitur berubah.
clipboardEvent clipboardEventCallback Fungsi callback yang akan dipanggil ketika a clipboardEvent dihasilkan.
deviceChangeEvent deviceChangeEventCallback Fungsi callback yang akan dipanggil ketika suatu deviceChange peristiwa dipicu.
screenshot screenshotCallback Fungsi callback yang akan dipanggil ketika a screenshot tersedia.

ConnectionConfig

Konfigurasi untuk DCV koneksi Amazon.

Jenis:

  • Objek

Properti:

Nama Tipe Deskripsi
url string Nama host dan port DCV server Amazon yang sedang berjalan dalam format berikut:https://dcv_host_address:port. Sebagai contoh: https://my-dcv-server:8443.
sessionId string ID DCV sesi Amazon.
authToken string Token otentikasi yang digunakan saat menghubungkan ke server.
baseUrl string Mutlak atau relatif URL dari mana untuk memuat SDK file.
resourceBaseUrl string Mutlak atau relatif URL dari mana untuk mengakses DCV sumber daya.
enabledChannels Array. < Kanal > Menunjukkan daftar saluran yang dapat diaktifkan. Jika tidak ditentukan atau array kosong disediakan, default ke semua saluran yang tersedia.
losslessColorspace Ruang Warna Menunjukkan ruang warna yang akan digunakan. Jika tidak ditentukan, defaultnya adalah "”. RGB
divId string ID div objek di HTML DOM mana SDK harus membuat kanvas dengan aliran jarak jauh.
volumeLevel integer Level volume yang disukai. Rentang yang valid adalah 0 hingga 100.
clipboardAutoSync boolean Menunjukkan apakah penyalinan otomatis dari clipboard DCV sesi Amazon ke clipboard klien lokal diaktifkan untuk browser web yang kompatibel.
dynamicAudioTuning boolean Menunjukkan apakah akan menyetel audio secara dinamis berdasarkan pengaturan audio DCV server Amazon saat koneksi dibuat.
clientHiDpiScaling boolean Menunjukkan apakah akan menskalakan kanvas berdasarkan klienDPI.
highColorAccuracy boolean Menunjukkan apakah akurasi warna yang tinggi harus digunakan jika tersedia. Jika tidak ditentukan, defaultnya ke. false
enableWebCodecs Boolean Menunjukkan apakah WebCodecs harus digunakan jika tersedia. Default hingga false jika tidak ditentukan.
observers connectionCallbacks Fungsi callback untuk memanggil peristiwa yang terkait dengan koneksi.
callbacks connectionCallbacks Sama seperti observers properti, tetapi setiap callback menyertakan objek Connection sebagai parameter pertama.

ConnectionErrorCode

Enum ConnectionError kode tersedia dalam modul DCV

  • ALREADY_OPEN

  • INVALID_CONFIG

  • INITIALIZATION_FAILED

  • REJECTED

  • MAIN_CHANNEL_ALREADY_OPEN

  • GENERIC_ERROR(sejak DCV Server 2021.0)

  • INTERNAL_SERVER_ERROR(sejak DCV Server 2021.0)

  • AUTHENTICATION_FAILED(sejak DCV Server 2021.0)

  • PROTOCOL_ERROR(sejak DCV Server 2021.0)

  • INVALID_SESSION_ID(sejak DCV Server 2021.0)

  • INVALID_CONNECTION_ID(sejak DCV Server 2021.0)

  • CONNECTION_LIMIT_REACHED(sejak DCV Server 2021.0)

  • SERVER_UNREACHABLE(sejak DCV Server 2022.1)

  • GATEWAY_BUSY

  • UNSUPPORTED_CREDENTIAL(sejak DCV Server 2022.2)

  • TRANSPORT_ERROR

Jenis:

  • number

createDirectory(jalan)

Parameter:

Nama Tipe Deskripsi
path string Jalur absolut di server tempat kita ingin membuat direktori. Ini juga harus menyertakan nama direktori target.

CustomChannelErrorCode

Enum CustomChannelError kode tersedia dalam modul DCV

  • TRANSPORT_ERROR

Jenis:

  • number

dataChannelCallback(info)

Fungsi callback yang akan dipanggil ketika DCV server Amazon mengirimkan pemberitahuan tentang ketersediaan saluran data.

Parameter:

Nama Tipe Deskripsi
info Objek Informasi tentang saluran data.
Nama Tipe Deskripsi
name string Nama saluran data.
token string Token otentikasi untuk saluran data.

deleteFile(jalan)

Parameter:

Nama Tipe Deskripsi
path string Jalur absolut pada server mengidentifikasi file yang ingin kita hapus.

deviceChangeEventPanggilan balik ()

Fungsi callback yang akan dipanggil ketika suatu deviceChange peristiwa dipicu.

disconnectCallback(alasan)

Fungsi callback yang akan dipanggil ketika koneksi berakhir.

Parameter:

Nama Tipe Deskripsi
reason Objek Alasan pemutusan.
Nama Tipe Deskripsi
code number Kode alasannya.
message string Pesan alasannya.

displayAvailabilityCallback(status,displayId)

Fungsi callback yang akan dipanggil saat ketersediaan tampilan berubah.

Parameter:

Nama Tipe Deskripsi
status Objek Status tampilan.
Nama Tipe Deskripsi
enabled boolean Menunjukkan jika tampilan diaktifkan.
closed boolean Menunjukkan jika tampilan ditutup.
displayId number Pengidentifikasi untuk tampilan.

DisplayConfigErrorCode

Enum DisplayConfigError kode tersedia dalam modul DCV

  • INVALID_ARGUMENT

  • UNSUPPORTED_OPERATION

  • NO_CHANNEL

Jenis:

  • number

displayLayoutCallback(serverWidth,serverHeight, kepala)

Fungsi callback yang akan dipanggil ketika tata letak tampilan atau resolusi diubah.

Parameter:

Nama Tipe Deskripsi
serverWidth number Lebar (dalam piksel) dari tampilan utama.
serverHeight number Ketinggian (dalam piksel) dari tampilan utama.
heads Array. < Memantau > Kepala tampilan didukung oleh DCV server Amazon.

fitur

Nilai fitur.

  • display- Menunjukkan ketersediaan aliran video layar tunggal.

  • display-multi- Menunjukkan ketersediaan aliran video multi-tampilan.

  • high-color-accuracy- Menunjukkan ketersediaan akurasi warna yang tinggi (sejak Amazon DCV Web Client SDK versi 1.1.0).

  • mouse- Menunjukkan ketersediaan fungsionalitas mouse.

  • keyboard- Menunjukkan ketersediaan fungsionalitas keyboard.

  • keyboard-sas- Menunjukkan ketersediaan fungsi SAS urutan (Control+Alt+Delete).

  • relative-mouse- Menunjukkan ketersediaan mode mouse relatif.

  • clipboard-copy- Menunjukkan ketersediaan fungsionalitas salinan clipboard dari DCV server Amazon ke klien.

  • clipboard-paste- Menunjukkan ketersediaan fungsionalitas tempel clipboard dari klien ke server AmazonDCV.

  • audio-in- Menunjukkan ketersediaan fungsionalitas input audio menggunakan mikrofon.

  • audio-out- Menunjukkan ketersediaan fungsi pemutaran audio.

  • webcam- Menunjukkan ketersediaan fungsionalitas streaming webcam.

  • file-download- Menunjukkan ketersediaan fungsionalitas unduhan file dari DCV server Amazon ke klien.

  • file-upload- Menunjukkan ketersediaan fungsionalitas unggah file dari klien ke DCV server Amazon.

  • timezone-redirection- Menunjukkan ketersediaan fungsi pengalihan zona waktu (sejak Amazon DCV Web Client SDK versi 1.3.0).

Jenis:

  • string

featuresUpdateCallback(featuresList)

Fungsi callback yang akan dipanggil ketika status fitur berubah.

Parameter:

Nama Tipe Deskripsi
featuresList Array. < fitur> Berbagai fitur yang telah berubah.

fileDownloadCallback(fileResource)

Fungsi callback yang akan dipanggil ketika file siap diunduh dari DCV server Amazon.

Parameter:

Nama Tipe Deskripsi
fileResource Objek Informasi tentang file yang siap diunduh.
Nama Tipe Deskripsi
id string Pengenal untuk file tersebut.
url string Yang digunakan URL untuk mengunduh file.
domain string Domain sumber daya.
token string Token otentikasi yang digunakan untuk mengunduh file. Token juga termasuk dalamURL.

filePrintedCallback(printResource)

Fungsi callback yang akan dipanggil ketika file dicetak di DCV server Amazon.

Parameter:

Nama Tipe Deskripsi
printResource Objek Informasi tentang file yang dicetak.
Nama Tipe Deskripsi
id string Pengidentifikasi untuk file yang dicetak.
url string Yang digunakan URL untuk mengunduh file yang dicetak.
domain string Domain sumber daya. Dalam hal ini,printer.
token string Token otentikasi yang digunakan untuk mengunduh file yang dicetak. Token juga termasuk dalamURL.

filestorage

Objek yang memungkinkan untuk menjelajahi dan melakukan tindakan pada sistem file.

Jenis:

  • Objek

Properti:

Nama Tipe Deskripsi
list daftar Fungsi yang memungkinkan untuk daftar item (file dan direktori) hadir di jalur yang disediakan di server.
createDirectory createDirectory Fungsi yang memungkinkan untuk membuat direktori di jalur yang ditentukan di server.
retrieveFile retrieveFile Fungsi yang memungkinkan untuk mengunduh file secara lokal di jalur yang ditentukan di server.
deleteFile deleteFile Fungsi yang memungkinkan untuk menghapus file di jalur yang ditentukan di server.
renameFile renameFile Fungsi yang memungkinkan untuk mengganti nama file dari jalur sumber yang ditentukan ke jalur tujuan yang ditentukan.
renameDirectory renameDirectory Fungsi yang memungkinkan untuk mengganti nama direktori dari jalur sumber yang ditentukan ke jalur tujuan absolut.
storeFile storeFile Fungsi yang memungkinkan untuk mengunggah file lokal ke jalur yang disediakan di server.

filestorageEnabledCallback(diaktifkan)

Fungsi callback yang akan dipanggil ketika penyimpanan file diaktifkan. Saluran malas hanya di Internet Explorer 11.

Parameter:

Nama Tipe Deskripsi
enabled boolean Menunjukkan apakah penyimpanan file diaktifkan.

FileStorageErrorCode

Enum FileStorageError kode tersedia dalam modul DCV

  • CANCELLED

  • ABORTED

  • INVALID_ARGUMENT

  • NOT_IMPLEMENTED

  • ERROR

  • ALREADY_EXIST

  • NOT_FOUND

Jenis:

  • number

firstFrameCallback(resizeEnabled, relativeMouseMode Diaktifkan,displayId)

Fungsi callback yang akan dipanggil ketika frame pertama diterima dari DCV server Amazon. Dipancarkan untuk setiap tampilan.

Parameter:

Nama Tipe Deskripsi
resizeEnabled boolean Menunjukkan apakah server mendukung mengubah ukuran tata letak tampilan klien.
relativeMouseModeEnabled boolean Menunjukkan apakah server mendukung mode mouse relatif.
displayId number Pengidentifikasi untuk tampilan.

idleWarningNotificationPanggilan balik () disconnectionDateTime

Fungsi callback yang akan dipanggil saat DCV server Amazon mengirimkan peringatan batas waktu idle.

Parameter:

Nama Tipe Deskripsi
disconnectionDateTime Tanggal Tanggal dan waktu pemutusan.

collaboratorListCallback(kolaborator)

Fungsi callback yang akan dipanggil ketika DCV server Amazon mengirimkan daftar kolaborator.

Parameter:

Nama Tipe Deskripsi
collaborators Array. <Object> Daftar objek yang berisi informasi tentang kolaborator.
Nama Tipe Deskripsi
username string Nama pengguna kolaborator.
owner boolean Menunjukkan apakah kolaborator adalah pemilik sesi.
connectionId number Menunjukkan ID yang ditetapkan oleh server ke koneksi.

licenseNotificationCallback(pemberitahuan)

Fungsi callback yang akan dipanggil ketika DCV server Amazon mengirimkan pemberitahuan tentang status lisensi.

Parameter:

Nama Tipe Deskripsi
notification Objek Pemberitahuan.
Nama Tipe Deskripsi
product string DCVProduk.
status string Status lisensi.
message string Sebuah pesan.
leftDays number Jumlah hari sebelum lisensi berakhir.
isDemo boolean Menunjukkan apakah lisensi adalah lisensi demo.
numUnlicensed number Jumlah koneksi yang tidak berlisensi.
licensingMode string Mode perizinan.
documentationUrl string URLUntuk dokumentasi.

daftar (jalur)

Parameter:

Nama Tipe Deskripsi
path string Jalur absolut di server yang ingin kami daftarkan kontennya.

LogLevel

Level SDK log yang tersedia.

Jenis:

  • TRACE | DEBUG | INFO | WARN | ERROR | SILENT

Memantau

Jenis:

  • Objek

Properti:

Nama Tipe Deskripsi
name string Nama kepala tampilan.
rect Objek Informasi tentang kepala tampilan.
Nama Tipe Deskripsi
x number xKoordinat awal untuk kepala tampilan.
y number yKoordinat awal untuk kepala tampilan.
width number Lebar (dalam piksel) dari kepala tampilan.
height number Ketinggian (dalam piksel) dari kepala tampilan.
primary boolean Menunjukkan apakah kepala tampilan adalah kepala tampilan utama. Ini ditentukan dari sistem operasi jarak jauh jika tersedia.
dpi number Bagian DPI dari kepala tampilan.

MultiMonitorErrorCode

Enum MultiMonitorError kode tersedia dalam modul DCV

  • NO_DISPLAY_CHANNEL

  • MAX_DISPLAY_NUMBER_REACHED

  • INVALID_ARGUMENT

  • DISPLAY_NOT_OPENED_BY_SERVER

  • REQUEST_TIMEOUT

  • GENERIC_ERROR

  • NO_ERROR

Jenis:

  • number

qualityIndicatorStateCallback (status)

Fungsi callback yang akan dipanggil ketika indikator kualitas koneksi berubah status.

Parameter:

Nama Tipe Deskripsi
state Array. <Object> Informasi tentang kualitas koneksi.
Nama Tipe Deskripsi
name string Nama indikatornya.
status NORMAL | WARNING | CRITICAL Deskripsi status.
changed boolean Menunjukkan apakah status berubah.

renameDirectory(src, dest)

Parameter:

Nama Tipe Deskripsi
src string Jalur sumber absolut di server mengidentifikasi direktori yang ingin kita ganti nama.
dest string Jalur tujuan absolut di server yang menentukan jalur target dan nama direktori.

renameFile(src, dest)

Parameter:

Nama Tipe Deskripsi
src string Jalur sumber absolut di server mengidentifikasi file yang ingin kita ganti nama.
dest string Jalur tujuan absolut di server yang menentukan jalur target dan nama file.

ResolutionErrorCode

Enum ResolutionError kode tersedia dalam modul DCV

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • NOT_IMPLEMENTED

Jenis:

  • number

retrieveFile(jalan)

Parameter:

Nama Tipe Deskripsi
path string Jalur absolut di server mengidentifikasi file yang ingin kita unduh secara lokal.

screenshotCallback(tangkapan layar)

Fungsi callback yang akan dipanggil ketika tangkapan layar tersedia.

Parameter:

Nama Tipe Deskripsi
screenshot byte [] Buffer tangkapan layar dalam PNG format, atau null jika pengambilan tangkapan layar gagal.

ScreenshotErrorCode

Enum ScreenshotError kode tersedia dalam modul DCV

  • NO_CHANNEL

  • GENERIC_ERROR

Jenis:

  • number

serverInfo

Jenis:

  • Objek

Properti:

Nama Tipe Deskripsi
name string Nama perangkat lunak.
version Objek Nomor versi perangkat lunak.
Nama Tipe Deskripsi
major number Nomor versi utama.
minor number Nomor versi minor.
revision number Nomor versi revisi.
os string OS.
arch string Arsitekturnya.
hostname string Nama host.

statistik

Jenis:

  • Objek

Properti:

Nama Tipe Deskripsi
fps number Frame saat ini per detik.
traffic number Lalu lintas saat ini dalam bit/s.
peakTraffic number Puncak lalu lintas dalam bit/s sejak koneksi dibuat.
latency number Latensi saat ini di ms.
currentChannels number Jumlah saluran yang telah dibuka sejak koneksi dibuat.
openedChannels number Jumlah saluran yang saat ini dibuka.
channelErrors number Jumlah saluran yang melaporkan kesalahan.

storeFile(berkas, dir)

Parameter:

Nama Tipe Deskripsi
file File Objek file (untuk informasi lebih lanjut lihat https://developer.mozilla.org/en-US/docs/Web/ API /File) kita ingin meng-upload ke server.
dir string Jalur absolut di server tempat kami ingin mengunggah file.

TimezoneRedirectionErrorCode

Enum TimezoneRedirectionError kode tersedia dalam modul DCV

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • USER_CANNOT_CHANGE

Jenis:

  • number

TimezoneRedirectionSettingCode

Enum TimezoneRedirectionSetting kode tersedia dalam modul DCV

  • ALWAYS_OFF

  • ALWAYS_ON

  • CLIENT_DECIDES

Jenis:

  • number

TimezoneRedirectionStatusCode

Enum TimezoneRedirectionStatus kode tersedia dalam modul DCV

  • SUCCESS

  • PERMISSION_ERROR

  • GENERIC_ERROR

Jenis:

  • number

WebcamErrorCode

Enum WebcamError kode tersedia dalam modul DCV

  • SETTING_WEBCAM_FAILED

  • CHANNEL_NOT_AVAILABLE

Jenis:

  • number