streaming

Documentation

Index

• Constants
• Variables
• func AddM3U8Header(next http.Handler) http.Handler
• func RegisterRoutes(router *mux.Router)
• type Error
• type PlaybackSession
  • func NewPlaybackSession(playbackSessionKey PlaybackSessionKey, segmentIdx int, ...) (*PlaybackSession, error)
  • func (s *PlaybackSession) CleanupIfRequired()
  • func (s *PlaybackSession) Release()
• type PlaybackSessionKey
• type PlaybackSessionManager
  • func NewPlaybackSessionManager() (m *PlaybackSessionManager, cleanup func())
  • func (m *PlaybackSessionManager) CleanupSessions()
  • func (m *PlaybackSessionManager) GetPlaybackSession(playbackSessionKey PlaybackSessionKey, segmentIdx int) (*PlaybackSession, error)
  • func (m *PlaybackSessionManager) GetPlaybackSessionByID(playbackSessionID string) (*PlaybackSession, error)
  • func (m *PlaybackSessionManager) GetPlaybackSessions() map[PlaybackSessionKey]*PlaybackSession
• type StatusError
  • func (se StatusError) Error() string
  • func (se StatusError) Status() int

Constants

const InitSegmentIdx = -1

Variables

var PBSManager, _ = NewPlaybackSessionManager()

Functions

func AddM3U8Header

func AddM3U8Header(next http.Handler) http.Handler

For Apple devices to handle HLS properly, the m3u8 playlists must be sent with the correct Content-Type

func RegisterRoutes

func RegisterRoutes(router *mux.Router)

RegisterRoutes registers streaming routes to an existing router

Types

type Error

type Error interface {
	error
	Status() int
}

Error represents a handler error. It provides methods for a HTTP status code and embeds the built-in error interface.

type PlaybackSession

type PlaybackSession struct {
	PlaybackSessionKey

	TranscodingSession *ffmpeg.TranscodingSession
	// contains filtered or unexported fields
}

func NewPlaybackSession

func NewPlaybackSession(playbackSessionKey PlaybackSessionKey, segmentIdx int, m *PlaybackSessionManager) (*PlaybackSession, error)

func (*PlaybackSession) CleanupIfRequired

func (s *PlaybackSession) CleanupIfRequired()

func (*PlaybackSession) Release

func (s *PlaybackSession) Release()

type PlaybackSessionKey

type PlaybackSessionKey struct {
	ffmpeg.StreamKey
	// contains filtered or unexported fields
}

type PlaybackSessionManager

type PlaybackSessionManager struct {
	// contains filtered or unexported fields
}

func NewPlaybackSessionManager

func NewPlaybackSessionManager() (m *PlaybackSessionManager, cleanup func())

func (*PlaybackSessionManager) CleanupSessions

func (m *PlaybackSessionManager) CleanupSessions()

Cleanup cleans up any streaming artifacts that might be left.

func (*PlaybackSessionManager) GetPlaybackSession

func (m *PlaybackSessionManager) GetPlaybackSession(
	playbackSessionKey PlaybackSessionKey,
	segmentIdx int) (*PlaybackSession, error)

GetPlaybackSession gets a playback session with the given key and for the given segment index. If the segment index is too far in the future, it will conclude that the user likely skipped ahead and start a new playback session. If segmentIdx == InitSegmentIdx, any session will be returned for the given (StreamKey, representationID). This is useful to get a session to serve the init segment from because it doesn't matter where ffmpeg seeked to, the init segment will always be the same. The returned PlaybackSession must be released after use by calling ReleasePlaybackSession.

func (*PlaybackSessionManager) GetPlaybackSessionByID

func (m *PlaybackSessionManager) GetPlaybackSessionByID(playbackSessionID string) (*PlaybackSession, error)

GetPlaybackSessionByID gets the playback session by its ID. If one with the given ID does not exist, and error is returned. The returned PlaybackSession must be released after use by calling ReleasePlaybackSession.

func (*PlaybackSessionManager) GetPlaybackSessions

func (m *PlaybackSessionManager) GetPlaybackSessions() map[PlaybackSessionKey]*PlaybackSession

type StatusError

type StatusError struct {
	Code int
	Err  error
}

StatusError represents an error with an associated HTTP status code.

func (StatusError) Error

func (se StatusError) Error() string

Allows StatusError to satisfy the error interface.

func (StatusError) Status

func (se StatusError) Status() int

Returns our HTTP status code.