route

Documentation

Index

• Constants
• type RequestCreateRoute
• type RequestDestination
• type RequestSource
• type RequestStartOrStopRoutes
• type ResponseCreateRoute
• type ResponseDestination
• type ResponseRouteModel
• type ResponseRoutes
• type ResponseSource
• type ResponseStartOrRoute
• type RouteModel

Constants

const (
	START_ROUTE = "start-route"
	STOP_ROUTE  = "stop-route"
)

Types

type RequestCreateRoute

type RequestCreateRoute[TS RequestSource, TD RequestDestination] struct {
	Action      string `json:"action" required:"true" validate:"nonnil,min=1"`
	DeviceID    string `json:"deviceID" required:"true" validate:"nonnil,min=1"`
	ElementType string `json:"elementType" required:"true" validate:"nonnil,min=1"`
	Fields      struct {
		Name         string `json:"name" required:"true" validate:"nonnil,min=1"`
		StartRoute   bool   `json:"startRoute" required:"true" validate:"nonnil,min=1"`
		Source       TS     `json:"source" required:"true"`
		Destinations []TD   `json:"destinations" required:"true"`
	}
}

{
	"action": "create",
	"deviceID": "[Device ID]",
	"elementType": "route",
	"fields":
	{
	"name": "[Route name]",
	"startRoute": [true,false],
	"source":
		{
		<Source object>
		},
		"destinations": [
		<Destination object list>
		// destinations udp and rtp
		// destinations srt
		// destinations hls
		]
	}
}

type RequestDestination

type RequestDestination interface {
	srt.RequestDestinationModelSrt | udprtp.RequestDestinationModelUdpRtp | rtmp.RequestDestinationModelRtmp | rtsp.RequestDestinationModelRtsp
}

request destination

type RequestSource

type RequestSource interface {
	srt.RequestSourceModelSRT | udprtp.RequestSourceModelUdpRtp | rtmp.RequestSourceModelRTMP | rtsp.RequestSourceModelRTSP
}

request source

type RequestStartOrStopRoutes

type RequestStartOrStopRoutes struct {
	DeviceID   string `json:"deviceID" required:"true" validate:"nonnil,min=1"`
	Command    string `json:"command" required:"true" validate:"nonnil,min=1"`
	Parameters struct {
		RouteID string `json:"routeID" required:"true" validate:"nonnil,min=1"`
	}
}

type ResponseCreateRoute

type ResponseCreateRoute struct {
	Status string `json:"status"`
}

type ResponseDestination

type ResponseDestination interface {
	udprtp.ResponseDestinationUdpRtp | srt.ResponseDestinationSrt | hls.ResponseDestinationHls
}

type ResponseRouteModel

type ResponseRouteModel[TS ResponseSource, TD ResponseDestination] struct {
	ID                   string `json:"id"`
	Name                 string `json:"name"`
	Source               TS     `json:"source"`
	Destinations         []TD   `json:"destinations"`
	ElapsedTime          string `json:"elapsedTime"`
	State                string `json:"state"`
	PendingUpdates       int    `json:"pendingUpdates"`
	SummaryStatusCode    string `json:"summaryStatusCode"`
	SummaryStatusDetails string `json:"summaryStatusDetails"`
	HasPendingDelete     bool   `json:"hasPendingDelete"`
}

type ResponseRoutes

type ResponseRoutes[TS ResponseSource, TD ResponseDestination] struct {
	Data                       []ResponseRouteModel[TS, TD] `json:"data"`
	NumPages                   int                          `json:"numPages"`
	NumResults                 int                          `json:"numResults"`
	NumActiveOutputConnections int                          `json:"numActiveOutputConnections"`
	PendingRouteCreates        int                          `json:"pendingRouteCreates"`
}

{
  "data": { [
    <Array of Route Objects>
  ]},
  "numPages": 1,
  "numResults": 3,
  "numActiveOutputConnections": 1,
  "pendingRouteCreates": 1
}

type ResponseSource

type ResponseSource interface {
	udprtp.ResponseSourceUdpRtp | srt.ResponseSourceSrt | rtmp.ResponseSourceRtmp
}

type ResponseStartOrRoute

type ResponseStartOrRoute struct {
	Response []struct {
		Action     string `json:"action"`
		Command    string `json:"command"`
		Parameters struct {
			RouteID string `json:"routeID"`
		} `json:"parameters"`
		DeviceID    string `json:"deviceID"`
		CreatedAt   int64  `json:"createdAt"`
		CompletedAt int64  `json:"completedAt"`
		Result      string `json:"result"`
		State       string `json:"state"`
		ID          string `json:"_id"`
	}
}

type RouteModel

type RouteModel[TS RequestSource, TD RequestDestination] struct {
	ID                   string `json:"id"`
	Name                 string `json:"name"`
	Source               TS     `json:"source"`
	Destinations         []TD   `json:"destinations"`
	ElapsedTime          string `json:"elapsedTime"`
	State                string `json:"state"`
	PendingUpdates       int    `json:"pendingUpdates"`
	SummaryStatusCode    string `json:"summaryStatusCode"`
	SummaryStatusDetails string `json:"summaryStatusDetails"`
	HasPendingDelete     bool   `json:"hasPendingDelete"`
}