egressobs

package
v1.45.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 18, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Code generated; DO NOT EDIT.

Index

Constants

View Source
const Version_5HDLFF0 = true

Variables

This section is empty.

Functions

func GetAudioOnly added in v1.45.0

func GetAudioOnly(info *livekit.EgressInfo) bool

func GetRequest added in v1.45.0

func GetRequest(info *livekit.EgressInfo) (string, error)

func GetResult added in v1.45.0

func GetResult(info *livekit.EgressInfo) (string, error)

Types

type EgressReporter

type EgressReporter interface {
	RegisterFunc(func(ts time.Time, tx EgressTx) bool)
	Tx(func(tx EgressTx))
	TxAt(time.Time, func(tx EgressTx))
	WithSession(id string) SessionReporter
	WithDeferredSession() (SessionReporter, KeyResolver)
	EgressTx
}

func NewNoopEgressReporter

func NewNoopEgressReporter() EgressReporter

type EgressRequestType

type EgressRequestType string
const (
	EgressRequestTypeUndefined      EgressRequestType = ""
	EgressRequestTypeRoomComposite  EgressRequestType = "room_composite"
	EgressRequestTypeTrackComposite EgressRequestType = "track_composite"
	EgressRequestTypeTrack          EgressRequestType = "track"
	EgressRequestTypeParticipant    EgressRequestType = "participant"
	EgressRequestTypeWeb            EgressRequestType = "web"
)

func GetRequestType added in v1.45.0

func GetRequestType(info *livekit.EgressInfo) EgressRequestType

type EgressResults added in v1.45.0

type EgressResults struct {
	FileResults    []*livekit.FileInfo
	StreamResults  []*livekit.StreamInfo
	SegmentResults []*livekit.SegmentsInfo
	ImageResults   []*livekit.ImagesInfo
}

type EgressStatus

type EgressStatus string
const (
	EgressStatusUndefined    EgressStatus = ""
	EgressStatusStarting     EgressStatus = "starting"
	EgressStatusActive       EgressStatus = "active"
	EgressStatusEnding       EgressStatus = "ending"
	EgressStatusComplete     EgressStatus = "complete"
	EgressStatusFailed       EgressStatus = "failed"
	EgressStatusAborted      EgressStatus = "aborted"
	EgressStatusLimitReached EgressStatus = "limit_reached"
)

type EgressTx

type EgressTx interface {
	ReportRequestType(v EgressRequestType)
	ReportRoomName(v string)
	ReportRequest(v string)
	ReportAudioOnly(v bool)
	ReportStartTime(v time.Time)
	ReportEndTime(v time.Time)
	ReportUpdateTime(v time.Time)
	ReportStatus(v EgressStatus)
	ReportDetails(v string)
	ReportError(v string)
	ReportErrorCode(v int32)
	ReportResult(v string)
	ReportManifestLocation(v string)
}

type KeyResolver

type KeyResolver interface {
	Resolve(string)
	Reset()
}

type ProjectReporter

type ProjectReporter interface {
	RegisterFunc(func(ts time.Time, tx ProjectTx) bool)
	Tx(func(tx ProjectTx))
	TxAt(time.Time, func(tx ProjectTx))
	WithEgress(id string) EgressReporter
	WithDeferredEgress() (EgressReporter, KeyResolver)
	ProjectTx
}

func NewNoopProjectReporter

func NewNoopProjectReporter() ProjectReporter

type ProjectTx

type ProjectTx interface{}

type Reporter

type Reporter interface {
	WithProject(id string) ProjectReporter
	WithDeferredProject() (ProjectReporter, KeyResolver)
}

func NewNoopReporter

func NewNoopReporter() Reporter

type Rollup

type Rollup string
const (
	RollupUndefined      Rollup = ""
	RollupProject        Rollup = "project"
	RollupEgressIndex    Rollup = "egress_index"
	RollupEndTimeIndex   Rollup = "end_time_index"
	RollupStartTimeIndex Rollup = "start_time_index"
	RollupRoomNameIndex  Rollup = "room_name_index"
	RollupEgressEgress   Rollup = "egress_egress"
	RollupSessionIndex   Rollup = "session_index"
)

type SessionReporter added in v1.45.0

type SessionReporter interface {
	RegisterFunc(func(ts time.Time, tx SessionTx) bool)
	Tx(func(tx SessionTx))
	TxAt(time.Time, func(tx SessionTx))
	SessionTx
}

func NewNoopSessionReporter added in v1.45.0

func NewNoopSessionReporter() SessionReporter

type SessionSourceType added in v1.45.0

type SessionSourceType string
const (
	SessionSourceTypeUndefined SessionSourceType = ""
	SessionSourceTypeSdk       SessionSourceType = "sdk"
	SessionSourceTypeWeb       SessionSourceType = "web"
)

func GetSourceType added in v1.45.0

func GetSourceType(info *livekit.EgressInfo) SessionSourceType

type SessionStatus added in v1.45.0

type SessionStatus string
const (
	SessionStatusUndefined    SessionStatus = ""
	SessionStatusStarting     SessionStatus = "starting"
	SessionStatusActive       SessionStatus = "active"
	SessionStatusEnding       SessionStatus = "ending"
	SessionStatusComplete     SessionStatus = "complete"
	SessionStatusFailed       SessionStatus = "failed"
	SessionStatusAborted      SessionStatus = "aborted"
	SessionStatusLimitReached SessionStatus = "limit_reached"
)

func GetStatus added in v1.45.0

func GetStatus(info *livekit.EgressInfo) SessionStatus

type SessionTx added in v1.45.0

type SessionTx interface {
	ReportStartTime(v time.Time)
	ReportEndTime(v time.Time)
	ReportUpdateTime(v time.Time)
	ReportDuration(v uint64)
	ReportRetryCount(v uint32)
	ReportSourceType(v SessionSourceType)
	ReportRegion(v string)
	ReportRoomID(v string)
	ReportStatus(v SessionStatus)
	ReportDetails(v string)
	ReportError(v string)
	ReportErrorCode(v int32)
	ReportManifestLocation(v string)
	ReportBackupStorageUsed(v bool)
	ReportResult(v string)
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL