obs browser
v1.31
O Browser apresenta uma fonte de navegador de plataforma cruzada, alimentada pelo CEF (Chromium incorporado à estrutura), no OBS Studio. Uma fonte do navegador permite ao usuário integrar sobreposições baseadas na Web em suas cenas, com acesso completo às APIs da Web modernas.
Além disso, o Browser permite a integração de serviços (vinculando serviços de terceiros) e docas do navegador (páginas da web carregadas na própria interface) em todas as plataformas suportadas, exceto para Wayland (Linux).
Este plug -in está incluído por padrão em pacotes oficiais no Windows, MacOS, o Ubuntu PPA e o FlatPak oficial (a maioria das distribuições Linux).
O Browser fornece um objeto global que permite o acesso a algumas funcionalidades específicas da OBS do JavaScript. Isso pode ser usado para criar uma sobreposição que se adapte dinamicamente às mudanças no OBS.
Se você estiver usando o TypeScript, as definições de tipo para as ligações do navegador estão disponíveis no NPM e no YARN.
# 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 )
} ) As descrições para esses eventos podem ser encontradas aqui.
Permissões necessárias: nenhuma
/**
* @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 )
} ) Permissões necessárias: 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 )
} ) Permissões necessárias: 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 )
} ) Permissões necessárias: read_user
/**
* @callback ScenesCallback
* @param {string[]} scenes
*/
/**
* @param {ScenesCallback} cb - The callback that receives the scenes.
*/
window . obsstudio . getScenes ( function ( scenes ) {
console . log ( scenes )
} ) Permissões necessárias: read_user
/**
* @callback TransitionsCallback
* @param {string[]} transitions
*/
/**
* @param {TransitionsCallback} cb - The callback that receives the transitions.
*/
window . obsstudio . getTransitions ( function ( transitions ) {
console . log ( transitions )
} ) Permissões necessárias: 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 )
} ) Permissões necessárias: básico
/**
* Does not accept any parameters and does not return anything
*/
window . obsstudio . saveReplayBuffer ( ) Permissões necessárias: Avançado
/**
* Does not accept any parameters and does not return anything
*/
window . obsstudio . startReplayBuffer ( ) Permissões necessárias: Avançado
/**
* Does not accept any parameters and does not return anything
*/
window . obsstudio . stopReplayBuffer ( ) Permissões necessárias: Avançado
/**
* @param {string} name - Name of the scene
*/
window . obsstudio . setCurrentScene ( name ) Permissões necessárias: Avançado
/**
* @param {string} name - Name of the transition
*/
window . obsstudio . setCurrentTransition ( name ) Permissões necessárias: tudo
/**
* Does not accept any parameters and does not return anything
*/
window . obsstudio . startStreaming ( ) Permissões necessárias: tudo
/**
* Does not accept any parameters and does not return anything
*/
window . obsstudio . stopStreaming ( ) Permissões necessárias: tudo
/**
* Does not accept any parameters and does not return anything
*/
window . obsstudio . startRecording ( ) Permissões necessárias: tudo
/**
* Does not accept any parameters and does not return anything
*/
window . obsstudio . stopRecording ( ) Permissões necessárias: tudo
/**
* Does not accept any parameters and does not return anything
*/
window . obsstudio . pauseRecording ( ) Permissões necessárias: tudo
/**
* Does not accept any parameters and does not return anything
*/
window . obsstudio . unpauseRecording ( ) Permissões necessárias: tudo
/**
* Does not accept any parameters and does not return anything
*/
window . obsstudio . startVirtualcam ( ) Permissões necessárias: tudo
/**
* Does not accept any parameters and does not return anything
*/
window . obsstudio . stopVirtualcam ( )Este método é legado. Registre um ouvinte de evento em vez disso.
/**
* 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 ) {
} ;Este método é legado. Registre um ouvinte de evento em vez disso.
/**
* 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 ) {
} ; O Browser inclui a integração com as solicitações de fornecedores da Obbesocket. O nome do fornecedor a ser usado é obs-browser e as solicitações disponíveis são:
emit_event - pega event_name e? parâmetros event_data . Emite um evento personalizado para todas as fontes do navegador. Para se inscrever nos eventos, veja aquiNão há eventos de fornecedor disponíveis no momento.
O navegador OBS não pode ser construído independente. É construído como parte do estúdio OB.
Seguindo as instruções, isso permitirá as docas de fonte e navegador do navegador nas três plataformas. BUILD_BROWSER e CEF_ROOT_DIR são necessários.
Siga as instruções de construção e faça o download do invólucro CEF e defina CEF_ROOT_DIR em cmake para apontar para o invólucro extraído.
Use o script de compilação completa do MacOS. Isso baixará e ativará automaticamente o navegador OB.
Siga as instruções de compilação e escolha a opção "Se construir com fonte de navegador". Isso inclui etapas para baixar/extrair o invólucro CEF e definir as variáveis cmake necessárias.
