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 ) {

} ;