スクリプト関数のエクスポート
スクリプトはオプションで、次のような多数のグローバル関数を提供できます。
script_load(設定)
スクリプトに関連付けられた特定の設定でスクリプトが開始されるときに呼び出されます。提供されたセットアップ パラメーターは通常、ユーザー設定の設定には使用されず、スクリプトで使用される可能性のある追加の内部セットアップ データに使用されます。
参数 settings – 与脚本关联的设置。
script_unload()
スクリプトをアンインストールするときに呼び出されます。
script_save(設定)
スクリプトを保存するときに呼び出されます。これはユーザー設定の設定には必要ありませんが、代わりに、スクリプトで使用される可能性のある追加の内部設定データに使用されます。
参数 settings – 与脚本关联的设置。
script_defaults (設定)
スクリプトに関連付けられたデフォルト設定がある場合は、それを設定するために呼び出されます。通常は、設定のデフォルト値関数を呼び出してデフォルト値を設定します。
参数 settings – 与脚本关联的设置。
script_update(設定)
当用户更改脚本的设置（如果有）时调用。
参数 settings – 与脚本关联的设置。
script_properties()
スクリプトに関連付けられたユーザー プロパティを定義するために呼び出されます。これらのプロパティは、設定プロパティがユーザーにどのように表示されるかを定義します。
返回 通过 obs_properties_create() 创建的 obs_properties_t 对象。
script_tick(秒)
フレームごとの処理が必要な状況でフレームごとに呼び出されます。タイマーが必要な場合は、代わりにスクリプト タイマーを使用してください。基本的なタイマー機能のみが必要な場合は、タイマーの方が効率的です。Python のグローバル インタープリタ ロックのため、Python でこの関数を使用することはお勧めできません。
参数 seconds – 自上一帧以来经过的秒数。
現在のスクリプトのパスを取得します
関数を使用して、現在のスクリプトのパスを取得できます。この関数は、スクリプトをロードする前にすべてのスクリプトに自動的に実装され、obslua/obspython ではなくスクリプト名前空間の一部です。
スクリプトパス()
返回 脚本的路径。
スクリプトタイマー
スクリプト タイマーは、フレームごとにスクリプト/インタープリターをロックすることなく、タイマー コールバックを提供する効率的な方法を提供します。(これらの関数は、obspython/obslua モジュール/名前空間の一部です)。
timer_add(コールバック、ミリ秒)
ミリ秒ごとに起動するタイマー コールバックを追加します。
timer_remove(コールバック)
タイマー コールバックを削除します。(注: タイマー コールバック内からタイマーを強制終了するには、remove_current_callback() を使用することもできます)
C API とのその他の違い
コールバックの動作方法により、一部の関数は C API とは異なる方法で実装されます。(これらの関数は、obspython/obslua モジュール/名前空間の一部です)。
obs_enum_sources()
すべてのソースを列挙します。
返回 一组引用递增的源。使用 source_list_release() 发布。
obs_scene_enum_items(シーン)
シーン内のシーン アイテムを列挙します。
参数 场景 - obs_scene_t 对象来枚举项目。
返回 场景项目列表。使用 sceneitem_list_release() 发布。
obs_add_main_render_callback（コールバック）
Lua のみ: メイン出力レンダリング コールバックを追加します。このコールバックにはパラメータがありません。
参数 callback – 渲染回调。使用 obs_remove_main_render_callback() 或 remove_current_callback() 删除回调。
obs_remove_main_render_callback (コールバック)
Lua のみ: メイン出力レンダリング コールバックを削除します。
参数 callback – 渲染回调。
signal_handler_connect（ハンドラー、シグナル、コールバック）
シグナル ハンドラーの特定のシグナルにコールバックを追加します。このコールバックには、calldata_t オブジェクトという 1 つのパラメータがあります。
参数 handler – 一个 signal_handler_t 对象。
signal - 信号处理程序上的信号（string）
callback – 连接到信号的回调。使用 signal_handler_disconnect() 或remove_current_callback() 删除回调。
signal_handler_disconnect（ハンドラー、シグナル、コールバック）
特定の信号のシグナル ハンドラーからコールバックを削除します。
参数 handler – 一个 signal_handler_t 对象。
signal - 信号处理程序上的信号（字符串）
callback -- 断开信号的回调。
signal_handler_connect_global（ハンドラー、コールバック）
グローバル コールバックをシグナル ハンドラーに追加します。このコールバックは 2 つのパラメータを取ります。最初のパラメータは信号文字列で、2 番目のパラメータは calldata_t オブジェクトです。
参数 handler – 一个 signal_handler_t 对象。
callback -- 要连接的回调。使用 signal_handler_disconnect_global() 或 remove_current_callback() 删除回调。
signal_handler_disconnect_global（ハンドラー、コールバック）
シグナル ハンドラーからグローバル コールバックを削除します。
参数 handler – 一个 signal_handler_t 对象。
callback -- 断开连接的回调。
obs_hotkey_register_frontend（名前、説明、コールバック）
フロントエンドのホットキーを追加しました。コールバックは 1 つのパラメータ、つまりブール値の「pressed」パラメータを受け入れます。
参数 name -- 热键的唯一名称标识符字符串。
description – 向用户显示的热键描述。
callback – 热键的回调。使用 obs_hotkey_unregister() 或 remove_current_callback() 删除回调。
obs_hotkey_unregister(コールバック)
指定されたコールバックに関連付けられたホットキーの登録を解除します。
参数 callback – 取消注册的热键回调。
obs_properties_add_button（プロパティ、設定名、テキスト、コールバック）
ボタンのプロパティを obs_properties_t オブジェクトに追加します。コールバックには 2 つのパラメータがあります。最初のパラメータは obs_properties_t オブジェクト、2 番目のパラメータはボタンの obs_property_t です。
参数 properties – 一个 obs_properties_t 对象。
setting_name – 设置标识符字符串。
text – 按钮文本。
回调 - 按钮回调。此回调会自动清理。
Remove_current_callback()
現在実行中のコールバックを削除します。コールバック内にない場合は、何もしません。
ソースリストリリース(ソースリスト)
ソースリストへの参照を解放します。
参数 source_list – 要发布的源数组。
sceneitem_list_release(アイテムリスト)
シーンアイテムリストへの参照を解除します。
参数 item_list – 要发布的场景项目数组。
calldata_source (呼び出しデータ、名前)
calldata_t オブジェクトのポインター引数を obs_source_t オブジェクトにキャストします。
参数 calldata – 一个 calldata_t 对象。
name -- 参数的名称。
返回
对 obs_source_t 对象的借用引用。
calldata_sceneitem(calldata, 名前)
calldata_t オブジェクトのポインター引数を obs_sceneitem_t オブジェクトにキャストします。
参数 calldata – 一个 calldata_t 对象。
name -- 参数的名称。
返回
对 obs_sceneitem_t 对象的借用引用。