简介

go-obs-websocket是一个与OBS进行websocket通信的连接库，具备调用大部分OBS功能的接口，在互动直播和智能转播技术上广泛应用。

快速开始

安装

go get github.com/christopher-dG/go-obs-websocket

obs简介

go-obs-websocket 是一个与OBS进行websocket通信的连接库，具备调用大部分OBS功能的接口，在互动直播和智能转播技术上广泛应用。

建立连接

import obsws "github.com/christopher-dG/go-obs-websocket"

c := obsws.Client{Host: "localhost", Port: 4444}
 if err := c.Connect(); err != nil {
  log.Fatal(err)
 }
 defer c.Disconnect()

发送请求

// Send and receive a request asynchronously.
 req := obsws.NewGetStreamingStatusRequest()
 if err := req.Send(c); err != nil {
  log.Fatal(err)
 }

// This will block until the response comes (potentially forever).
 resp, err := req.Receive()
 if err != nil {
  log.Fatal(err)
 }
 log.Println("streaming:", resp.Streaming)

创建请求，这里创建的是流状态请求
发送请求
获取请求结果这里的请求会阻塞当前协程，当OBS正处于推流时，resp.Steaming值为true，反之为false。

_go-obs-websocket_ 提供了众多请求接口，可以使用如下命令获取

#linux
go doc github.com/christopher-dG/go-obs-websocket |grep "Request " |grep type

#windows
go doc github.com/christopher-dG/go-obs-websocket |findstr "Request " | findstr type

接下来我们挑几个常见的来看看使用案例

开始/停止推流

req := obsws.NewStartStopStreamingRequest()
 if err := req.Send(c); err != nil {
  log.Fatal(err)
 }

resp, err := req.Receive()
 if err != nil {
  log.Fatal(err)
 }
 log.Println("streaming:", resp.Status())

开始录制

req := obsws.NewStartRecordingRequest()
 if err := req.Send(c); err != nil {
  log.Fatal(err)
 }

resp, err := req.Receive()
 if err != nil {
  log.Fatal(err)
 }
 log.Println("streaming:", resp.Status())

停止录制

 req := obsws.NewStopRecordingRequest()
 if err := req.Send(c); err != nil {
  log.Fatal(err)
 }

resp, err := req.Receive()
 if err != nil {
  log.Fatal(err)
 }
 log.Println("streaming:", resp.Status())

转换场景

req := obsws.NewSetCurrentSceneRequest("scene1")
if err := req.Send(c); err != nil {
    log.Fatal(err)
}

resp, err := req.Receive()
if err != nil {
    log.Fatal(err)
}
 log.Println("streaming:", resp.Status())

处理响应

c.AddEventHandler("SwitchScenes", func(e obsws.Event) {
    // Make sure to assert the actual event type.
    log.Println("new scene:", e.(obsws.SwitchScenesEvent).SceneName)
    })

注册钩子函数，响应OBS的信号。一共可注册的钩子函数key如下：

"SwitchScenes"                  场景切换
"ScenesChanged"                 场景变化
"SceneCollectionChanged"        场景来源变化
"SceneCollectionListChanged"    场景来源列表变化
"SwitchTransition"              转场
"TransitionListChanged"         转场列表变化
"TransitionDurationChanged"     转场时长变化
"TransitionBegin"               开始转场
"ProfileChanged"                配置变化
"ProfileListChanged"            配置文件列表变化
"StreamStarting"                推流开始启动
"StreamStarted"                 推流启动完成
"StreamStopping"                推流正在停止
"StreamStopped"                 推流已暂停
"StreamStatus"                  推流状态
"RecordingStarting"             
"RecordingStarted"              
"RecordingStopping"             
"RecordingStopped"              
"RecordingPaused"               
"RecordingResumed"              
"ReplayStarting"                回放
"ReplayStarted"                 
"ReplayStopping"                
"ReplayStopped"                 
"Exiting"                      退出 
"Heartbeat"                    心跳 
"BroadcastCustomMessage"       广播消息 
"SourceCreated"                来源创建
"SourceDestroyed"              来源销毁
"SourceVolumeChanged"          来源音频改变
"SourceMuteStateChanged"       音量改变
"SourceAudioSyncOffsetChanged" 
"SourceAudioMixersChanged"      
"SourceRenamed"                 
"SourceFilterAdded"            滤波添加 
"SourceFilterRemoved"          滤波移除
"SourceFilterVisibilityChanged" 滤波可见性改变
"SourceFiltersReordered"        
"SourceOrderChanged"           来源顺序变换 
"SceneItemAdded"               场景元素添加
"SceneItemRemoved"             场景元素移除 
"SceneItemVisibilityChanged"    
"SceneItemTransformChanged"     
"SceneItemSelected"             
"SceneItemDeselected"           
"PreviewSceneChanged"           
"StudioModeSwitched"