egressobs

package

v1.53.1 Latest Latest Go to latest Published: Oct 26, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/livekit/protocol

Links

Open Source Insights

Documentation ¶

Overview ¶

Code generated by cloud-observability; DO NOT EDIT.

Index ¶

Constants
func GetAudioOnly(info *livekit.EgressInfo) bool
func GetRequest(info *livekit.EgressInfo) (string, error)
func GetResult(info *livekit.EgressInfo) (string, error)
type EgressReporter
- func NewNoopEgressReporter() EgressReporter
type EgressRequestType
- func GetRequestType(info *livekit.EgressInfo) EgressRequestType
type EgressResults
type EgressStatus
- func GetStatus(info *livekit.EgressInfo) EgressStatus
type EgressTx
type KeyResolver
type ProjectReporter
- func NewNoopProjectReporter() ProjectReporter
type ProjectTx
type Reporter
- func NewNoopReporter() Reporter
type Rollup
type SessionReporter
- func NewNoopSessionReporter() SessionReporter
type SessionSourceType
- func GetSourceType(info *livekit.EgressInfo) SessionSourceType
type SessionTx

Constants ¶

View Source

const Version_HAKUONO = 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)
	// contains filtered or unexported methods
}

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"
	EgressRequestTypeEgress         EgressRequestType = "egress"
	EgressRequestTypeReplay         EgressRequestType = "replay"
)

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     `json:"file_results,omitempty"`
	StreamResults  []*livekit.StreamInfo   `json:"stream_results,omitempty"`
	SegmentResults []*livekit.SegmentsInfo `json:"segment_results,omitempty"`
	ImageResults   []*livekit.ImagesInfo   `json:"image_results,omitempty"`
}

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"
)

func GetStatus ¶ added in v1.45.0

func GetStatus(info *livekit.EgressInfo) EgressStatus

type EgressTx ¶

type EgressTx interface {
	Project() ProjectTx
	// contains filtered or unexported methods
}

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)
	// contains filtered or unexported methods
}

func NewNoopProjectReporter ¶

func NewNoopProjectReporter() ProjectReporter

type ProjectTx ¶

type ProjectTx interface {
	// contains filtered or unexported methods
}

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"
	// Deprecated: removed from schema; retained for compatibility with stored data.
	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))
	// contains filtered or unexported methods
}

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"
	SessionSourceTypeTemplate  SessionSourceType = "template"
	SessionSourceTypeMedia     SessionSourceType = "media"
)

func GetSourceType ¶ added in v1.45.0

func GetSourceType(info *livekit.EgressInfo) SessionSourceType

type SessionTx ¶ added in v1.45.0

type SessionTx interface {
	Egress() EgressTx
	// contains filtered or unexported methods
}

Source Files ¶

View all Source files

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