streamdeck-obs-replay/obsws/events_streaming.go

89 lines
2.8 KiB
Go
Raw Normal View History

2020-01-15 04:32:53 +00:00
package obsws
// This file is automatically generated.
// https://github.com/christopher-dG/go-obs-websocket/blob/master/codegen/protocol.py
// StreamStartingEvent : A request to start streaming has been issued.
//
// Since obs-websocket version: 0.3.
//
// https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#streamstarting
type StreamStartingEvent struct {
// Always false (retrocompatibility).
// Required: Yes.
PreviewOnly bool `json:"preview-only"`
_event `json:",squash"`
}
// StreamStartedEvent : Streaming started successfully.
//
// Since obs-websocket version: 0.3.
//
// https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#streamstarted
type StreamStartedEvent struct {
_event `json:",squash"`
}
// StreamStoppingEvent : A request to stop streaming has been issued.
//
// Since obs-websocket version: 0.3.
//
// https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#streamstopping
type StreamStoppingEvent struct {
// Always false (retrocompatibility).
// Required: Yes.
PreviewOnly bool `json:"preview-only"`
_event `json:",squash"`
}
// StreamStoppedEvent : Streaming stopped successfully.
//
// Since obs-websocket version: 0.3.
//
// https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#streamstopped
type StreamStoppedEvent struct {
_event `json:",squash"`
}
// StreamStatusEvent : Emit every 2 seconds.
//
// Since obs-websocket version: 0.3.
//
// https://github.com/Palakis/obs-websocket/blob/4.3-maintenance/docs/generated/protocol.md#streamstatus
type StreamStatusEvent struct {
// Current streaming state.
// Required: Yes.
Streaming bool `json:"streaming"`
// Current recording state.
// Required: Yes.
Recording bool `json:"recording"`
// Current replay state.
// Required: Yes.
Replay bool `json:"replay-buffer-active"`
// Always false (retrocompatibility).
// Required: Yes.
PreviewOnly bool `json:"preview-only"`
// Amount of data per second (in bytes) transmitted by the stream encoder.
// Required: Yes.
BytesPerSec int `json:"bytes-per-sec"`
// Amount of data per second (in kilobits) transmitted by the stream encoder.
// Required: Yes.
KbitsPerSec int `json:"kbits-per-sec"`
// Percentage of dropped frames.
// Required: Yes.
Strain float64 `json:"strain"`
// Total time (in seconds) since the stream started.
// Required: Yes.
TotalStreamTime int `json:"total-stream-time"`
// Total number of frames transmitted since the stream started.
// Required: Yes.
NumTotalFrames int `json:"num-total-frames"`
// Number of frames dropped by the encoder since the stream started.
// Required: Yes.
NumDroppedFrames int `json:"num-dropped-frames"`
// Current framerate.
// Required: Yes.
FPS float64 `json:"fps"`
_event `json:",squash"`
}