egressobs

package

v1.44.0 Latest Latest Go to latest Published: Jan 16, 2026 License: Apache-2.0 Imports: 1 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; DO NOT EDIT.

Index ¶

Constants
type EgressReporter
- func NewNoopEgressReporter() EgressReporter
type EgressRequestType
type EgressSourceType
type EgressStatus
type EgressTx
type KeyResolver
type ProjectReporter
- func NewNoopProjectReporter() ProjectReporter
type ProjectTx
type Reporter
- func NewNoopReporter() Reporter
type Rollup

Constants ¶

View Source

const Version_A7A5178 = true

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type EgressReporter ¶

type EgressReporter interface {
	RegisterFunc(func(ts time.Time, tx EgressTx) bool)
	Tx(func(tx EgressTx))
	TxAt(time.Time, func(tx EgressTx))
	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"
)

type EgressSourceType ¶

type EgressSourceType string

const (
	EgressSourceTypeUndefined EgressSourceType = ""
	EgressSourceTypeSdk       EgressSourceType = "sdk"
	EgressSourceTypeWeb       EgressSourceType = "web"
)

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 {
	ReportStartTime(v time.Time)
	ReportEndTime(v time.Time)
	ReportUpdateTime(v time.Time)
	ReportDuration(v uint64)
	ReportRequestType(v EgressRequestType)
	ReportSourceType(v EgressSourceType)
	ReportRegion(v string)
	ReportRoomName(v string)
	ReportRoomID(v string)
	ReportStatus(v EgressStatus)
	ReportDetails(v string)
	ReportError(v string)
	ReportErrorCode(v int32)
	ReportManifestLocation(v string)
	ReportBackupStorageUsed(v bool)
	ReportResult(v string)
	ReportRequest(v string)
	ReportAudioOnly(v bool)
}

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

Source Files ¶

View all Source files

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