obs browser下載 - obs browser源代碼下載

obs-browser

Obs-Browser引入了一個由CEF（Chromium Embedded Framework）提供動力的跨平台瀏覽器源，向OBS Studio。瀏覽器源允許用戶將基於Web的疊加層集成到他們的場景中，並完全訪問現代Web API。

此外，OBS-BROWSER啟用了服務集成（鏈接第三方服務）和瀏覽器碼頭（加載到接口本身中的網頁），除Wayland（Linux）外，所有受支持的平台上都有。

該插件默認包含在Windows，MacOS，Ubuntu PPA和官方Flatpak（大多數Linux發行版）上的官方軟件包上。

JS結合

obs-browser提供了一個全局對象，該對象允許從JavaScript訪問某些OBS特定功能。這可以用來創建一個動態適應於觀察器的變化的覆蓋層。

打字稿類型定義

如果您使用的是打字稿，則可以通過NPM和紗線獲得obs-browser綁定的類型定義。

 # npm
npm install --save-dev @types/obs-studio

# yarn
yarn add --dev @types/obs-studio

獲取瀏覽器插件版本

 /**
 * @returns {string} OBS Browser plugin version
 */
window . obsstudio . pluginVersion
// => 2.17.0

註冊事件回調

 /**
 * @callback EventListener
 * @param {CustomEvent} event
 */

/**
 * @param {string} type
 * @param {EventListener} listener
 */
window . addEventListener ( 'obsSceneChanged' , function ( event ) {
	var t = document . createTextNode ( event . detail . name )
	document . body . appendChild ( t )
} )

可用事件

這些事件的描述可以在此處找到。

obsscenechanged
obsScenelistchanged
obstransitionchanged
obsTransitionListchanged
Obssourcevisiblechanged
obssourceyctivechanged
obsstreamingstarting
obsstreamingstarted
obsstreamingstopping
觀察到了
obsRecorTingStarting
持續記錄
coptrecortingpaused
obsRecorTingunpaused
遵守記錄
觀察播種
obsplaybufferstarting
obsplaybufferstart
obsplaybuffersav
obsreplaybufferstopping
obsreplaybufferstop
obsvirtualCamstarted
obsvirtualCAMSTOPPOP
obsexit
[通過obs-websocket供應商請求發射的任何自定義事件]

控制觀察

獲取網頁控制權限

所需的權限：無

 /**
 * @typedef {number} Level - The level of permissions. 0 for NONE, 1 for READ_OBS (OBS data), 2 for READ_USER (User data), 3 for BASIC, 4 for ADVANCED and 5 for ALL
 */

/**
 * @callback LevelCallback
 * @param {Level} level
 */

/**
 * @param {LevelCallback} cb - The callback that receives the current control level.
 */
window . obsstudio . getControlLevel ( function ( level ) {
    console . log ( level )
} )

獲得OBS輸出狀態

所需的權限：read_obs

 /**
 * @typedef {Object} Status
 * @property {boolean} recording - not affected by pause state
 * @property {boolean} recordingPaused
 * @property {boolean} streaming
 * @property {boolean} replaybuffer
 * @property {boolean} virtualcam
 */

/**
 * @callback StatusCallback
 * @param {Status} status
 */

/**
 * @param {StatusCallback} cb - The callback that receives the current output status of OBS.
 */
window . obsstudio . getStatus ( function ( status ) {
	console . log ( status )
} )

獲取當前場景

所需的權限：read_user

 /**
 * @typedef {Object} Scene
 * @property {string} name - name of the scene
 * @property {number} width - width of the scene
 * @property {number} height - height of the scene
 */

/**
 * @callback SceneCallback
 * @param {Scene} scene
 */

/**
 * @param {SceneCallback} cb - The callback that receives the current scene in OBS.
 */
window . obsstudio . getCurrentScene ( function ( scene ) {
    console . log ( scene )
} )

獲取場景

所需的權限：read_user

 /**
 * @callback ScenesCallback
 * @param {string[]} scenes
 */

/**
 * @param {ScenesCallback} cb - The callback that receives the scenes.
 */
window . obsstudio . getScenes ( function ( scenes ) {
    console . log ( scenes )
} )

獲得過渡

所需的權限：read_user

 /**
 * @callback TransitionsCallback
 * @param {string[]} transitions
 */

/**
 * @param {TransitionsCallback} cb - The callback that receives the transitions.
 */
window . obsstudio . getTransitions ( function ( transitions ) {
    console . log ( transitions )
} )

獲得當前的過渡

所需的權限：read_user

 /**
 * @callback TransitionCallback
 * @param {string} transition
 */

/**
 * @param {TransitionCallback} cb - The callback that receives the transition currently set.
 */
window . obsstudio . getCurrentTransition ( function ( transition ) {
    console . log ( transition )
} )

保存重播緩衝區

所需的權限：基本

 /**
 * Does not accept any parameters and does not return anything
 */
window . obsstudio . saveReplayBuffer ( )

開始重播緩衝區

所需的權限：高級

 /**
 * Does not accept any parameters and does not return anything
 */
window . obsstudio . startReplayBuffer ( )

停止重播緩衝區

所需的權限：高級

 /**
 * Does not accept any parameters and does not return anything
 */
window . obsstudio . stopReplayBuffer ( )

更改場景

所需的權限：高級

 /**
 * @param {string} name - Name of the scene
 */
window . obsstudio . setCurrentScene ( name )

設置當前過渡

所需的權限：高級

 /**
 * @param {string} name - Name of the transition
 */
window . obsstudio . setCurrentTransition ( name )

開始流式傳輸

所需的權限：全部

 /**
 * Does not accept any parameters and does not return anything
 */
window . obsstudio . startStreaming ( )

停止流媒體

所需的權限：全部

 /**
 * Does not accept any parameters and does not return anything
 */
window . obsstudio . stopStreaming ( )

開始錄製

所需的權限：全部

 /**
 * Does not accept any parameters and does not return anything
 */
window . obsstudio . startRecording ( )

停止記錄

所需的權限：全部

 /**
 * Does not accept any parameters and does not return anything
 */
window . obsstudio . stopRecording ( )

暫停記錄

所需的權限：全部

 /**
 * Does not accept any parameters and does not return anything
 */
window . obsstudio . pauseRecording ( )

解開記錄

所需的權限：全部

 /**
 * Does not accept any parameters and does not return anything
 */
window . obsstudio . unpauseRecording ( )

啟動虛擬相機

所需的權限：全部

 /**
 * Does not accept any parameters and does not return anything
 */
window . obsstudio . startVirtualcam ( )

停止虛擬相機

所需的權限：全部

 /**
 * Does not accept any parameters and does not return anything
 */
window . obsstudio . stopVirtualcam ( )

註冊可見性回調

這種方法是遺產。請註冊事件聽眾。

 /**
 * onVisibilityChange gets callbacks when the visibility of the browser source changes in OBS
 *
 * @deprecated
 * @see obsSourceVisibleChanged
 * @param {boolean} visibility - True -> visible, False -> hidden
 */
window . obsstudio . onVisibilityChange = function ( visibility ) {

} ;

註冊有效/非活動回調

這種方法是遺產。請註冊事件聽眾。

 /**
 * onActiveChange gets callbacks when the active/inactive state of the browser source changes in OBS
 *
 * @deprecated
 * @see obsSourceActiveChanged
 * @param {bool} True -> active, False -> inactive
 */
window . obsstudio . onActiveChange = function ( active ) {

} ;