Exportación de funciones de script
Opcionalmente, los scripts pueden proporcionar una serie de funciones globales:
script_load(configuración)
Se llama cuando el script comienza con la configuración específica asociada al script. El parámetro de configuración proporcionado normalmente no se usa para configuraciones establecidas por el usuario; en cambio, el parámetro se usa para cualquier dato de configuración interna adicional que pueda usarse en el script.
参数 settings – 与脚本关联的设置。
script_unload()
Se llama al desinstalar el script.
script_save(configuración)
Se llama al guardar el script. Esto no es necesario para las configuraciones establecidas por el usuario; en cambio, se usa para cualquier dato de configuración interna adicional que pueda usarse en el script.
参数 settings – 与脚本关联的设置。
script_defaults (configuración)
Se llama para establecer la configuración predeterminada asociada con el script, si corresponde. Normalmente llamaría a la función de valor predeterminado para que una configuración establezca su valor predeterminado.
参数 settings – 与脚本关联的设置。
script_update (configuración)
当用户更改脚本的设置（如果有）时调用。
参数 settings – 与脚本关联的设置。
propiedades_script_()
Se llama para definir las propiedades del usuario asociadas con el script. Estas propiedades definen cómo se muestran las propiedades de configuración al usuario.
返回 通过 obs_properties_create() 创建的 obs_properties_t 对象。
script_tick(segundos)
Se llama por fotograma en situaciones en las que se requiere procesamiento por fotograma. Si necesita un temporizador, utilice un temporizador de secuencia de comandos, ya que un temporizador es más eficiente si solo necesita la funcionalidad básica del temporizador. Debido al bloqueo global del intérprete de Python, no se recomienda utilizar esta función en Python.
参数 seconds – 自上一帧以来经过的秒数。
Obtener la ruta del script actual
Puede utilizar una función para obtener la ruta del script actual. Esta función se implementa automáticamente en cada script antes de cargarlo y es parte del espacio de nombres del script, no de obslua/obspython:
ruta_script()
返回 脚本的路径。
temporizador de guión
Los temporizadores de script proporcionan una manera eficiente de proporcionar devoluciones de llamadas del temporizador sin tener que bloquear el script/intérprete en cada fotograma. (Estas funciones son parte del módulo/espacio de nombres obspython/obslua).
timer_add(devolución de llamada, milisegundos)
Agregue una devolución de llamada de temporizador que se active cada milisegundo.
timer_remove (devolución de llamada)
Eliminar la devolución de llamada del temporizador. (Nota: también puedes usar remove_current_callback() para finalizar el temporizador desde la devolución de llamada del temporizador)
Otras diferencias con la API C
Debido a la forma en que funcionan las devoluciones de llamada, algunas funciones se implementan de manera diferente a la API de C. (Estas funciones son parte del módulo/espacio de nombres obspython/obslua).
obs_enum_fuentes()
Enumere todas las fuentes.
返回 一组引用递增的源。使用 source_list_release() 发布。
obs_scene_enum_items(escena)
Enumere los elementos de la escena en la escena.
参数 场景 - obs_scene_t 对象来枚举项目。
返回 场景项目列表。使用 sceneitem_list_release() 发布。
obs_add_main_render_callback (devolución de llamada)
Solo Lua: agregue devolución de llamada de representación de salida principal. Esta devolución de llamada no tiene parámetros.
参数 callback – 渲染回调。使用 obs_remove_main_render_callback() 或 remove_current_callback() 删除回调。
obs_remove_main_render_callback (devolución de llamada)
Solo Lua: elimina la devolución de llamada de representación de salida principal.
参数 callback – 渲染回调。
signal_handler_connect（controlador, señal, devolución de llamada）
Agregue una devolución de llamada a una señal específica en un controlador de señales. Esta devolución de llamada tiene un parámetro: el objeto calldata_t.
参数 handler – 一个 signal_handler_t 对象。
signal - 信号处理程序上的信号（string）
callback – 连接到信号的回调。使用 signal_handler_disconnect() 或remove_current_callback() 删除回调。
signal_handler_disconnect (controlador, señal, devolución de llamada)
Elimine las devoluciones de llamada de un controlador de señales para una señal específica.
参数 handler – 一个 signal_handler_t 对象。
signal - 信号处理程序上的信号（字符串）
callback -- 断开信号的回调。
signal_handler_connect_global (controlador, devolución de llamada)
Agregue devoluciones de llamadas globales a los controladores de señales. Esta devolución de llamada toma dos parámetros: el primer parámetro es la cadena de señal y el segundo parámetro es el objeto calldata_t.
参数 handler – 一个 signal_handler_t 对象。
callback -- 要连接的回调。使用 signal_handler_disconnect_global() 或 remove_current_callback() 删除回调。
signal_handler_disconnect_global (controlador, devolución de llamada)
Elimine las devoluciones de llamadas globales de los controladores de señales.
参数 handler – 一个 signal_handler_t 对象。
callback -- 断开连接的回调。
obs_hotkey_register_frontend (nombre, descripción, devolución de llamada)
Se agregaron teclas de acceso rápido en la interfaz. La devolución de llamada acepta un parámetro: un parámetro booleano "presionado".
参数 name -- 热键的唯一名称标识符字符串。
description – 向用户显示的热键描述。
callback – 热键的回调。使用 obs_hotkey_unregister() 或 remove_current_callback() 删除回调。
obs_hotkey_unregister(devolución de llamada)
Anula el registro de la tecla de acceso rápido asociada con la devolución de llamada especificada.
参数 callback – 取消注册的热键回调。
obs_properties_add_button (propiedades, nombre_configuración, texto, devolución de llamada)
Agregue propiedades de botón al objeto obs_properties_t. La devolución de llamada tiene dos parámetros: el primer parámetro es el objeto obs_properties_t y el segundo parámetro es el obs_property_t del botón.
参数 properties – 一个 obs_properties_t 对象。
setting_name – 设置标识符字符串。
text – 按钮文本。
回调 - 按钮回调。此回调会自动清理。
remove_current_callback()
Elimine la devolución de llamada que se está ejecutando actualmente. Si no está en la devolución de llamada, no hagas nada.
fuente_lista_liberación(lista_fuente)
Libere la referencia a la lista de fuentes.
参数 source_list – 要发布的源数组。
escenaitem_list_release(item_list)
Libera la referencia a la lista de elementos de la escena.
参数 item_list – 要发布的场景项目数组。
calldata_source (datos de llamada, nombre)
Convierte el argumento del puntero del objeto calldata_t a un objeto obs_source_t.
参数 calldata – 一个 calldata_t 对象。
name -- 参数的名称。
返回
对 obs_source_t 对象的借用引用。
calldata_sceneitem(calldata, nombre)
Convierta el argumento del puntero del objeto calldata_t a un objeto obs_sceneitem_t.
参数 calldata – 一个 calldata_t 对象。
name -- 参数的名称。
返回
对 obs_sceneitem_t 对象的借用引用。