Katalog API Runtime V2
57 entriDaftar lengkap kelas, koleksi, dan fungsi otomasi bawaan yang tersedia di CogniTab Script Runtime.
📦 Kelas
15 entri- →
AudioClassAudio(name)Nilai audio hanya baca untuk mengenali bunyi dalam aplikasi atau game. Gunakan Audio(name) untuk memuat sampel tersimpan, atau Audio.recent(duration_ms) untuk menyalin audio yang baru ditangkap. Penangkapan dan pencocokan berlangsung di perangkat; buffer pendengaran berkelanjutan tidak diunggah dan skrip tidak dapat mengakses audio mentah (PCM).
- →
ColorClassColor(value, /)Mewakili satu warna ARGB dan menyediakan bantuan pengambilan sampel/perbandingan warna.
- →
MacroPanelClassMacroPanel(title="", subtitle="", confirm_text="Run", cancel_text="Cancel", *, version="")Buat dan tampilkan panel input runtime untuk parameter makro yang dikontrol skrip.
- →
OverlayTextClassOverlayText(text="", position=(0, 0), color="#FFFFFFFF", size=16, background=None)Gambar teks di atas layar dengan pelacakan interaksi opsional (tekan/pindahkan/tahan). Nama penyetel seperti teks/latar belakang adalah metode; membaca nilai saat ini melalui state().
- →
PointClassPoint(x, y, /, scale="fixed", anchor="none")Sebuah titik di layar, diukur dalam piksel. Pemetaan koordinat kontrol skala/jangkar di seluruh ukuran layar. Setelah pemetaan dan offset, konsumen runtime memasukkan titik akhir ke rentang piksel valid layar saat ini. Titik dapat didestrukturkan menjadi x, y.
- →
RegionClassRegion(x, y, width, height, /, scale="fixed", anchor="none", scale_param=ScaleParam())A rectangular region on the screen, measured in pixels on the current screen axes. Scale/anchor control coordinate mapping across full-screen sizes without rotating through portrait coordinates or using the app viewport; runtime consumers clip the final region to the current screen after mapping and offsets. ScaleParam controls template matching inside this region. Region can be destructured as x, y, width, height.
- →
ScaleParamClassScaleParam(grayscale=True, auto_scale=False, cache_scale=True, template_scale="SHORT_EDGE", fast_matching=False)Parameter pencocokan templat untuk Region. fast_matching memperkecil gambar Region dan templat.
- →
ScreenCaptureClassScreenCaptureKontrol statis untuk pengambilan layar bersama selama proses makro saat ini. Cache otomatis biasanya menggunakan kembali frame hingga 100 ms untuk mengurangi beban pengambilan gambar. Untuk pengenalan berulang yang membutuhkan frame terbaru yang tersedia, gunakan auto_cache_off(); ini menambah beban pemrosesan dan penggunaan baterai, tanpa menjamin eksekusi lebih cepat atau piksel yang baru dirender. cache_on() menyematkan frame secara terpisah dan diprioritaskan di atas pengaturan cache otomatis.
- →
StorageClassStorageStorage key/value persisten untuk makro saat ini. Variabel biasa hanya dibagikan antar-action PYTHON_CODE berurutan dalam flow yang sama, termasuk action di dalam GROUP; flow paralel memiliki variabel terisolasi. Kunci Storage dipakai bersama oleh semua flow, jadi gunakan Storage ketika nilai harus bertahan ke run makro berikutnya, bukan sebagai kanal pesan antarproses. Penulisan disimpan otomatis setelah 2 detik tanpa penulisan baru dan di-commit lagi setelah seluruh Run makro dan semua flow latar berakhir.
- →
SwipePointClassSwipePoint(point, speed="NORMAL", delay_before=0, random=10, humanized=False, scale="fixed", anchor="none")Satu titik di dalam jalur gesek datar. Intinya harus berupa Titik atau tupel (x, y). Berikan daftar setidaknya dua nilai SwipePoint untuk menggesek([...]) untuk menggerakkan satu jari melalui beberapa titik.
- →
SystemClassSystem()Akses info sistem/perangkat runtime dan picu tindakan tingkat sistem dari skrip.
- →
TemplateClassTemplate(name, /)Pembungkus gambar templat. Anda dapat menskalakan/memotong templat yang sudah ada, menyimpannya sebagai nama templat baru, atau memeriksa keberadaannya.
- →
TfliteModelClassTfliteModel(model)TFLite model handle for scripts. The model type must be selected in Template Manager metadata. Supported outputs are YOLOv8/YOLO11 object detection [1,N,4+C]/[1,4+C,N], YOLO26 end-to-end detection [1,N,6]/[N,6], YOLO11/YOLO26 image classification [1,C], and MobileNetV3 image classification [1,C]. Runtime detects FLOAT32, INT8, or UINT8 tensor precision from the model and dequantizes quantized detection and classification outputs before applying thresholds. Classification matches return class confidence and metadata without point or bounds. Inference methods require a local model file; when local file is missing and runtime download fails, script raises a runtime error.
- →
TimerClassTimer(auto_start=True)Pembantu stopwatch milidetik untuk pemeriksaan waktu skrip dan waktu tunggu yang dijaga.
- →
TouchClassTouchPembantu statis untuk tindakan klik/gesek paralel yang dibuat oleh UI atau kode melalui klik(..., paralel=True) dan geser(..., paralel=True). Anda dapat mengumpulkan tindakan klik/gesek dan mengirimkannya bersama-sama, atau memeriksa tindakan klik/gesek yang aktif atau antri. Helper ini juga mendukung pembatalan tindakan klik/gesek aktif (khusus Android 8.0+).
🔒 Kelas hanya-baca
6 entri- →
AudioMatchRead-only ClassAudioMatchHasil pencocokan audio hanya-baca. Skor adalah kemiripan, bukan probabilitas ketepatan. Waktu find() memakai linimasa sesi mendengarkan; match() memakai linimasa nilai audio yang dicari. Bandingkan waktu agar satu suara tidak ditangani berulang. Gunakan waktu sebagai deteksi hanya jika matched adalah True.
- →
FlowRead-only ClassFlowKontrol statis untuk memulai flow makro bernama secara paralel. Maksimal dua flow latar dapat berjalan bersama flow utama, dan hanya satu pemanggilan aktif untuk setiap nama flow, termasuk saat dijeda atau dihentikan. Flow.start() segera mengembalikan nilai setelah coordinator menerima cabang; flow latar dapat memulai flow sebaya. Variabel terisolasi per cabang dan tidak pernah digabungkan ke pemanggil. Flow utama menunggu semua flow latar sebelum Run selesai. Nama tidak valid atau duplikat, kapasitas flow penuh, kesalahan cabang apa pun, System.stop(), atau Main Stop mengakhiri seluruh makro. Kontrol dock bernomor untuk setiap flow latar hanya dapat menjeda atau melanjutkan cabang itu sementara; tidak ada Stop per cabang. Pause atau Resume Main berlaku untuk semua cabang, dan Resume global juga menghapus tanda jeda lokal cabang. Gesture sentuh dari cabang berbeda dapat saling membatalkan. Kebijakan ScreenCapture dan audio capture dipakai bersama secara global. Storage memakai kunci persisten yang sama antar-cabang dan bukan kanal pesan antarproses.
- →
MatchRead-only ClassMatchHasil kecocokan pengenalan hanya baca yang dikembalikan oleh pembantu region.find*. Di cabang pengakuan Sukses, Recognition.result menunjuk ke Match atau MatchList yang aktif.
- →
MatchListRead-only ClassMatchListDaftar nilai Kecocokan hanya baca yang ditampilkan berdasarkan region.find_any/find_all/find_multi, wait_any/wait_all, dan Recognition.result ketika beberapa target pengenalan cocok.
- →
RecognitionRead-only ClassRecognitionDigunakan di cabang pengakuan keberhasilan di UI. Recognition.result mengembalikan Kecocokan untuk satu target pengenalan atau Daftar Kecocokan ketika beberapa target cocok.
- →
TouchStateRead-only ClassTouchState(id, status, kind, action_order, remaining_repeats, completed_repeats)Cuplikan satu skrip/item sentuh UI dalam antrean isyarat bersama.
📚 Koleksi
5 entri- →
dictCollectiondict(mapping_or_pairs=(), /, **items)Kumpulan kunci/nilai yang menyimpan urutan penyisipan dan dapat dibaca atau diperbarui selama eksekusi skrip.
- →
listCollectionlist(iterable=(), /)Koleksi terurut yang dapat Anda buat, baca, ulangi, ubah strukturnya, dan perbarui saat skrip berjalan.
- →
setCollectionset(iterable=None, /)Kumpulan nilai unik yang bisa berubah. CogniTab menjaga urutan iterasi tetap stabil sehingga keluaran skrip mudah dibaca.
- →
StringCollectionStringPengumpulan nilai teks. Dibuat oleh string literal atau str(nilai), kemudian dibaca dengan operasi panjang/indeks/loop.
- →
tupleCollectiontuple(iterable=(), /) (value1, value2, ...)Koleksi hanya-baca yang dipesan. Gunakan tuple literal ketika nilai harus tetap tetap setelah pembuatan atau ketika mengembalikan nilai yang dikelompokkan untuk destrukturisasi.
⚡ Fungsi
31 entriGestur
2 entri- →
clickFunctionclick(target, hold_ms=0, offset=(0, 0), random=0, delay_before=0, delay_after=0, parallel=False)Click on a Point, (x, y) tuple, Match, or MatchList. Every parameter supports positional or named form in the documented order. Use Point(x, y) for coordinate metadata such as scale/anchor; use (x, y) for fixed pixel coordinates. Use parallel=True to queue this touch and receive its numeric id; call Touch.cancel(id) or Touch.cancel() to cancel queued/active touches.
- →
swipeFunctionswipe(points, *, parallel=False)Lakukan gerakan menggesek dari daftar datar nilai SwipePoint. Setiap daftar menciptakan satu jalur multi-titik untuk satu jari.
Kontrol alur
5 entri- →
printFunctionprint(*values, sep=" ", end="\n")Write values to the overlay script console without blocking execution. Structured values use the same bounded display formatter as str(value), including row-based pretty output for two-dimensional lists, multi-line output for complex nesting, and explicit markers when content is omitted.
- →
randomFunctionrandom()Mengembalikan angka floating-point acak dalam rentang 0 -> 1.
- →
random_intFunctionrandom_int(min, max, /)Mengembalikan bilangan bulat acak dalam rentang min -> maks yang inklusif.
- →
rangeFunctionrange(stop, /) | range(start, stop, step=1, /)Hasilkan urutan bilangan bulat untuk digunakan dalam for-loop.
- →
waitFunctionwait(ms, /)Jeda eksekusi skrip selama beberapa milidetik tertentu.
Koleksi
4 entri- →
enumerateFunctionenumerate(iterable, start=0)Mengembalikan daftar pasangan Tuple(indeks, item) untuk nilai apa pun yang dapat diubah.
- →
lenFunctionlen(value, /)Dapatkan ukuran String, daftar/Tuple, atau dict.
- →
sortedFunctionsorted(iterable, /, *, key=None, reverse=False)Kembalikan daftar baru yang berisi semua item dari iterable dalam urutan yang diurutkan. kunci dapat menghitung kunci perbandingan; reverse=True mengurutkan secara menurun sambil menjaga item dengan kunci yang sama tetap stabil.
- →
zipFunctionzip(*iterables)Gabungkan iterable ke dalam daftar tupel, berhenti pada input terpendek.
Konversi tipe
5 entri- →
boolFunctionbool(value, /)Ubah nilai menjadi boolean menggunakan aturan skrip kebenaran/kesalahan.
- →
floatFunctionfloat(value, /)Berikan nilai ke angka floating-point.
- →
intFunctionint(value, /)Berikan nilai ke bilangan bulat (memotong bagian desimal).
- →
strFunctionstr(value, /)Convert value to string using DSL display format. Point/Region stay compact, two-dimensional lists render as one row list per line, and only rows that are too long or complex expand into vertical multi-line text. Large or deeply nested structured values use a bounded preview with explicit omitted/budget markers; a direct string value remains unchanged.
- →
typeFunctiontype(value, /)Mengembalikan string deskriptor kelas seperti Python untuk suatu nilai, misalnya <class 'int'>.
Matematika
14 entri- →
absFunctionabs(value, /)Kembalikan nilai absolut.
- →
ceilFunctionceil(value, /)Kembalikan bilangan bulat terkecil tidak lebih kecil dari nilai.
- →
clampFunctionclamp(value, min, max, /)Jepit nilai ke dalam rentang min -> maks.
- →
cosFunctioncos(value, /)Mengembalikan kosinus nilai dalam radian.
- →
floorFunctionfloor(value, /)Kembalikan bilangan bulat terbesar tidak lebih besar dari nilai.
- →
logFunctionlog(value, base=None, /)Kembalikan logaritma nilai. Menggunakan log natural ketika basis dihilangkan.
- →
maxFunctionmax(iterable, /, *, key=None) | max(iterable, /, *, default, key=None) | max(arg1, arg2, /, *args, key=None)Mengembalikan item terbesar dari satu iterable atau argumen terbesar dari dua argumen atau lebih. kunci dapat menghitung nilai yang digunakan untuk pemesanan; ikatan menjaga item pertama yang ditemui.
- →
minFunctionmin(iterable, /, *, key=None) | min(iterable, /, *, default, key=None) | min(arg1, arg2, /, *args, key=None)Mengembalikan item terkecil dari satu iterable atau argumen terkecil dari dua argumen atau lebih. kunci dapat menghitung nilai yang digunakan untuk pemesanan; ikatan menjaga item pertama yang ditemui.
- →
powFunctionpow(base, exponent, /)Naikkan basis ke eksponen.
- →
roundFunctionround(value, digits=0, /)Membulatkan nilai ke sejumlah digit desimal tertentu.
- →
sinFunctionsin(value, /)Mengembalikan nilai sinus dalam radian.
- →
sqrtFunctionsqrt(value, /)Mengembalikan akar kuadrat dari nilai non-negatif.
- →
sumFunctionsum(iterable, /, start=0)Mengembalikan jumlah angka dalam iterable, dengan nilai awal start jika diinginkan. Tanda kurung tersendiri pada generator expression hanya boleh dihilangkan jika generator merupakan satu-satunya argumen dalam pemanggilan fungsi atau metode; jika ada argumen lain atau koma di akhir, generator harus diapit tanda kurung.
- →
tanFunctiontan(value, /)Mengembalikan tangen nilai dalam radian.