data

Documentation

Index

• type Base
  • func (b *Base) ID() uuid.UUID
  • func (b *Base) StreamID() string
  • func (b *Base) Timestamp() time.Time
• type Event
  • func ParseEvent(data []byte) (Event, error)
• type EventType
• type MediaServerMetricsEvent
  • func NewMediaServerMetricsEvent(nodeID, region, streamID string, stats *StreamMetrics, ...) *MediaServerMetricsEvent
• type MultistreamMetrics
• type MultistreamTargetInfo
• type MultistreamTargetMetrics
• type MultistreamWebhookPayload
• type OrchestratorMetadata
• type SegmentMetadata
• type StreamMetrics
• type StreamState
• type StreamStateEvent
  • func NewStreamStateEvent(nodeID, region, userID, streamID string, state StreamState) *StreamStateEvent
• type TranscodeAttemptInfo
• type TranscodeEvent
  • func NewTranscodeEvent(nodeID, streamID string, seg SegmentMetadata, startTime time.Time, ...) *TranscodeEvent
• type UnixMillisTime
  • func NewUnixMillisTime(unixMillis int64) UnixMillisTime
  • func (u UnixMillisTime) MarshalJSON() ([]byte, error)
  • func (u UnixMillisTime) UnixMillis() int64
  • func (u *UnixMillisTime) UnmarshalJSON(data []byte) error
• type WebhookEvent
  • func NewWebhookEvent(streamID, event, userID, sessionID string, payload interface{}) (*WebhookEvent, error)

Types

type Base

type Base struct {
	Type       EventType      `json:"type"`
	ID_        uuid.UUID      `json:"id"`
	Timestamp_ UnixMillisTime `json:"timestamp"`
	StreamID_  string         `json:"streamId"`
}

func (*Base) ID

func (b *Base) ID() uuid.UUID

func (*Base) StreamID

func (b *Base) StreamID() string

func (*Base) Timestamp

func (b *Base) Timestamp() time.Time

type Event

type Event interface {
	ID() uuid.UUID
	Timestamp() time.Time
	StreamID() string
}

TODO: Call these just Message for consistency with livepeer-com

func ParseEvent

func ParseEvent(data []byte) (Event, error)

type EventType

type EventType string

const EventTypeMediaServerMetrics EventType = "media_server_metrics"

const EventTypeStreamState EventType = "stream_state"

const EventTypeTranscode EventType = "transcode"

const EventTypeWebhook EventType = "webhook_event"

type MediaServerMetricsEvent

type MediaServerMetricsEvent struct {
	Base
	NodeID      string                      `json:"nodeId"`
	Region      string                      `json:"region,omitempty"`
	Stats       *StreamMetrics              `json:"stats"`
	Multistream []*MultistreamTargetMetrics `json:"multistream"`
}

func NewMediaServerMetricsEvent

func NewMediaServerMetricsEvent(nodeID, region, streamID string, stats *StreamMetrics, multistream []*MultistreamTargetMetrics) *MediaServerMetricsEvent

type MultistreamMetrics

type MultistreamMetrics struct {
	ActiveSec   int64 `json:"activeSec"`
	Bytes       int64 `json:"bytes"`
	MediaTimeMs int64 `json:"mediaTimeMs"`
}

type MultistreamTargetInfo

type MultistreamTargetInfo struct {
	ID      string `json:"id"`
	Name    string `json:"name"`
	Profile string `json:"profile"`
}

type MultistreamTargetMetrics

type MultistreamTargetMetrics struct {
	Target  MultistreamTargetInfo `json:"target"`
	Metrics *MultistreamMetrics   `json:"metrics"`
}

type MultistreamWebhookPayload

type MultistreamWebhookPayload struct {
	Target MultistreamTargetInfo `json:"target"`
}

type OrchestratorMetadata

type OrchestratorMetadata struct {
	Address       string `json:"address"`
	TranscoderUri string `json:"transcodeUri"`
}

type SegmentMetadata

type SegmentMetadata struct {
	Name     string  `json:"name"`
	SeqNo    uint64  `json:"seqNo"`
	Duration float64 `json:"duration"`
	ByteSize int     `json:"byteSize"`
}

type StreamMetrics

type StreamMetrics struct {
	MediaTimeMs *int64 `json:"mediaTimeMs"`
}

type StreamState

type StreamState struct {
	Active bool `json:"active"`
}

type StreamStateEvent

type StreamStateEvent struct {
	Base
	NodeID string      `json:"nodeId"`
	Region string      `json:"region,omitempty"`
	UserID string      `json:"userId"`
	State  StreamState `json:"state"`
}

func NewStreamStateEvent

func NewStreamStateEvent(nodeID, region, userID, streamID string, state StreamState) *StreamStateEvent

type TranscodeAttemptInfo

type TranscodeAttemptInfo struct {
	Orchestrator OrchestratorMetadata `json:"orchestrator"`
	LatencyMs    int64                `json:"latencyMs"`
	Error        *string              `json:"error"`
}

type TranscodeEvent

type TranscodeEvent struct {
	Base
	NodeID    string                 `json:"nodeId"`
	Segment   SegmentMetadata        `json:"segment"`
	StartTime UnixMillisTime         `json:"startTime"`
	LatencyMs int64                  `json:"latencyMs"`
	Success   bool                   `json:"success"`
	Attempts  []TranscodeAttemptInfo `json:"attempts"`
}

func NewTranscodeEvent

func NewTranscodeEvent(nodeID, streamID string, seg SegmentMetadata, startTime time.Time, success bool, attempts []TranscodeAttemptInfo) *TranscodeEvent

type UnixMillisTime

type UnixMillisTime struct{ time.Time }

func NewUnixMillisTime

func NewUnixMillisTime(unixMillis int64) UnixMillisTime

func (UnixMillisTime) MarshalJSON

func (u UnixMillisTime) MarshalJSON() ([]byte, error)

func (UnixMillisTime) UnixMillis

func (u UnixMillisTime) UnixMillis() int64

func (*UnixMillisTime) UnmarshalJSON

func (u *UnixMillisTime) UnmarshalJSON(data []byte) error

type WebhookEvent

type WebhookEvent struct {
	Base
	Event     string          `json:"event"`
	UserID    string          `json:"userId"`
	SessionID string          `json:"sessionId,omitempty"`
	Payload   json.RawMessage `json:"payload,omitempty"`
}

func NewWebhookEvent

func NewWebhookEvent(streamID, event, userID, sessionID string, payload interface{}) (*WebhookEvent, error)