engine

package module
v0.7.0 Latest Latest
Warning

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

 Go to latest Published: Nov 28, 2021 License: MIT Imports: 28 Imported by: 39

README

ion-sdk-go

this is ion golang sdk for ion-sfu Feature:

  • Join a session
    • Join with config(NoPublish/NoSubscribe/Relay)
  • Subscribe from session
    • OnTrack(user-defined)
  • Publish file to session
    • webm
      • vp8+opus
      • vp9+opus
    • mp4(h264+opus)
    • simulcast(publish 3 files)
  • Publish rtp to session
    • audio|video only
    • audio codec(opus)
    • video codec
      • vp8
      • vp9
      • h264
  • Simulcast
    • subscribe
    • publish
  • Publish media device to session
    • camera
    • mic
    • screen
  • Support ion cluster

Documentation

Index

Constants

View Source 
const (
	MimeTypeH264 = "video/h264"
	MimeTypeOpus = "audio/opus"
	MimeTypeVP8  = "video/vp8"
	MimeTypeVP9  = "video/vp9"
)
View Source 
const (
	API_CHANNEL = "ion-sfu"
)

Variables

View Source 
var (
	DefaultConfig = RTCConfig{
		WebRTC: WebRTCTransportConfig{
			Configuration: webrtc.Configuration{
				ICEServers: []webrtc.ICEServer{
					{
						URLs: []string{"stun:stun.stunprotocol.org:3478", "stun:stun.l.google.com:19302"},
					},
				},
			},
		},
	}
)

Functions

func FileExist added in v0.7.0 

func FileExist(path string) bool

func GetArgs added in v0.7.0 

func GetArgs(args ...string) (arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10 string)

func GetError added in v0.7.0 

func GetError(err *room.Error) error

func RandomKey added in v0.7.0 

func RandomKey(n int) string

RandomKey generate a random string key

Types

type Call added in v0.2.0 

type Call struct {
	StreamID string `json:"streamId"`
	Video    string `json:"video"`
	Audio    bool   `json:"audio"`
}

Call dc api

type Connector added in v0.7.0 

type Connector struct {
	Metadata metadata.MD

	OnOpen  func(Service)
	OnClose func(Service, ServiceEvent)
	// contains filtered or unexported fields
}

func NewConnector added in v0.7.0 

func NewConnector(addr string, config ...ConnectorConfig) *Connector

NewConnector create a ion connector

func (*Connector) Close added in v0.7.0 

func (c *Connector) Close()

func (*Connector) OnEnd added in v0.7.0 

func (c *Connector) OnEnd(service Service, headers metadata.MD)

func (*Connector) OnHeaders added in v0.7.0 

func (c *Connector) OnHeaders(service Service, headers metadata.MD)

func (*Connector) RegisterService added in v0.7.0 

func (c *Connector) RegisterService(service Service)

type ConnectorConfig added in v0.7.0 

type ConnectorConfig struct {
	SSL    bool
	Cafile string
	Token  string
}

type JoinConfig added in v0.6.0 

type JoinConfig map[string]string

func NewJoinConfig added in v0.6.0 

func NewJoinConfig() *JoinConfig

func SetRelay added in v0.6.0 

func SetRelay(j JoinConfig) *JoinConfig

func (JoinConfig) SetNoAutoSubscribe added in v0.7.0 

func (j JoinConfig) SetNoAutoSubscribe() *JoinConfig

func (JoinConfig) SetNoPublish added in v0.6.0 

func (j JoinConfig) SetNoPublish() *JoinConfig

func (JoinConfig) SetNoSubscribe added in v0.6.0 

func (j JoinConfig) SetNoSubscribe() *JoinConfig

type JoinInfo added in v0.7.0 

type JoinInfo struct {
	Sid         string
	Uid         string
	DisplayName string
	ExtraInfo   []byte
	Destination string
	Role        Role
	Protocol    Protocol
	Avatar      string
	Direction   Peer_Direction
	Vendor      string
}

type MediaType added in v0.7.0 

type MediaType int32
const (
	MediaType_MediaUnknown  MediaType = 0
	MediaType_UserMedia     MediaType = 1
	MediaType_ScreenCapture MediaType = 2
	MediaType_Cavans        MediaType = 3
	MediaType_Streaming     MediaType = 4
	MediaType_VoIP          MediaType = 5
)

type PeerInfo added in v0.7.0 

type PeerInfo struct {
	Sid         string
	Uid         string
	DisplayName string
	ExtraInfo   []byte
	Destination string
	Role        Role
	Protocol    Protocol
	Avatar      string
	Direction   Peer_Direction
	Vendor      string
}

type PeerState added in v0.4.5 

type PeerState int32
const (
	PeerState_JOIN   PeerState = 0
	PeerState_UPDATE PeerState = 1
	PeerState_LEAVE  PeerState = 2
)

type Peer_Direction added in v0.7.0 

type Peer_Direction int32
const (
	Peer_INCOMING  Peer_Direction = 0
	Peer_OUTGOING  Peer_Direction = 1
	Peer_BILATERAL Peer_Direction = 2
)

type Protocol added in v0.7.0 

type Protocol int32
const (
	Protocol_ProtocolUnknown Protocol = 0
	Protocol_WebRTC          Protocol = 1
	Protocol_SIP             Protocol = 2
	Protocol_RTMP            Protocol = 3
	Protocol_RTSP            Protocol = 4
)

type RTC added in v0.7.0 

type RTC struct {
	Service

	//export to user
	OnTrack       func(track *webrtc.TrackRemote, receiver *webrtc.RTPReceiver)
	OnDataChannel func(*webrtc.DataChannel)
	OnError       func(error)
	OnTrackEvent  func(event TrackEvent)
	OnSpeaker     func(event []string)

	sync.Mutex
	// contains filtered or unexported fields
}

Client a sdk client

func NewRTC added in v0.7.0 

func NewRTC(connector *Connector, config ...RTCConfig) *RTC

func (*RTC) Close added in v0.7.0 

func (r *RTC) Close()

Close client close

func (*RTC) Connect added in v0.7.0 

func (r *RTC) Connect()

func (*RTC) Connected added in v0.7.0 

func (r *RTC) Connected() bool

func (*RTC) CreateDataChannel added in v0.7.0 

func (r *RTC) CreateDataChannel(label string) (*webrtc.DataChannel, error)

CreateDataChannel create a custom datachannel

func (*RTC) GetBandWidth added in v0.7.0 

func (r *RTC) GetBandWidth(cycle int) (int, int)

GetBandWidth call this api cyclely

func (*RTC) GetPubStats added in v0.7.0 

func (r *RTC) GetPubStats() webrtc.StatsReport

GetPubStats get pub stats

func (*RTC) GetPubTransport added in v0.7.0 

func (r *RTC) GetPubTransport() *Transport

func (*RTC) GetSubStats added in v0.7.0 

func (r *RTC) GetSubStats() webrtc.StatsReport

GetSubStats get sub stats

func (*RTC) GetSubTransport added in v0.7.0 

func (r *RTC) GetSubTransport() *Transport

func (*RTC) Join added in v0.7.0 

func (r *RTC) Join(sid, uid string, config ...*JoinConfig) error

Join client join a session

func (*RTC) Name added in v0.7.0 

func (r *RTC) Name() string

func (*RTC) Publish added in v0.7.0 

func (r *RTC) Publish(tracks ...webrtc.TrackLocal) ([]*webrtc.RTPTransceiver, error)

Publish local tracks

func (*RTC) PublishFile added in v0.7.0 

func (r *RTC) PublishFile(file string, video, audio bool) error

PublishWebm publish a webm producer

func (*RTC) SendAnswer added in v0.7.0 

func (r *RTC) SendAnswer(sdp webrtc.SessionDescription) error

func (*RTC) SendJoin added in v0.7.0 

func (r *RTC) SendJoin(sid string, uid string, offer webrtc.SessionDescription, config map[string]string) error

func (*RTC) SendOffer added in v0.7.0 

func (r *RTC) SendOffer(sdp webrtc.SessionDescription) error

func (*RTC) SendTrickle added in v0.7.0 

func (r *RTC) SendTrickle(candidate *webrtc.ICECandidate, target Target)

func (*RTC) Subscribe added in v0.7.0 

func (r *RTC) Subscribe(trackInfos []*Subscription) error

Subscribe to tracks

func (*RTC) SubscribeFromEvent added in v0.7.0 

func (r *RTC) SubscribeFromEvent(event TrackEvent, audio, video bool, layer string) error

SubscribeFromEvent will parse event and subscribe what you want

func (*RTC) UnPublish added in v0.7.0 

func (r *RTC) UnPublish(transceivers ...*webrtc.RTPTransceiver) error

UnPublish local tracks by transceivers

type RTCConfig added in v0.7.0 

type RTCConfig struct {
	WebRTC WebRTCTransportConfig `mapstructure:"webrtc"`
}

type Role added in v0.7.0 

type Role int32
const (
	Role_Host  Role = 0
	Role_Guest Role = 1
)

type Room added in v0.7.0 

type Room struct {
	Service

	sync.Mutex

	OnJoin       func(success bool, info RoomInfo, err error)
	OnLeave      func(success bool, err error)
	OnPeerEvent  func(state PeerState, Peer PeerInfo)
	OnMessage    func(from string, to string, data map[string]interface{})
	OnDisconnect func(sid, reason string)
	OnRoomInfo   func(info RoomInfo)
	OnError      func(error)
	// contains filtered or unexported fields
}

func NewRoom added in v0.7.0 

func NewRoom(connector *Connector) *Room

func (*Room) AddPeer added in v0.7.0 

func (r *Room) AddPeer(peer PeerInfo) error

AddPeer to room, at least a sid

func (*Room) Close added in v0.7.0 

func (c *Room) Close()

func (*Room) Connect added in v0.7.0 

func (c *Room) Connect()

func (*Room) Connected added in v0.7.0 

func (c *Room) Connected() bool

func (*Room) CreateRoom added in v0.7.0 

func (r *Room) CreateRoom(info RoomInfo) error

CreateRoom Params: sid password, at lease a sid

func (*Room) EndRoom added in v0.7.0 

func (r *Room) EndRoom(sid, reason string, delete bool) error

func (*Room) GetPeers added in v0.7.0 

func (r *Room) GetPeers(sid string) []PeerInfo

func (*Room) Join added in v0.7.0 

func (c *Room) Join(j JoinInfo) error

func (*Room) Leave added in v0.7.0 

func (c *Room) Leave(sid, uid string) error

Leave from one session

func (*Room) Name added in v0.7.0 

func (c *Room) Name() string

func (*Room) RemovePeer added in v0.7.0 

func (r *Room) RemovePeer(sid, uid string) error

func (*Room) SendMessage added in v0.7.0 

func (c *Room) SendMessage(sid, from, to string, data map[string]interface{}) error

SendMessage send message from is a uid to is a uid or "all"

func (*Room) UpdatePeer added in v0.7.0 

func (r *Room) UpdatePeer(peer PeerInfo) error

func (*Room) UpdateRoom added in v0.7.0 

func (r *Room) UpdateRoom(info RoomInfo) error

type RoomInfo added in v0.7.0 

type RoomInfo struct {
	Sid      string
	Name     string
	Password string
	Lock     bool
}

type Service added in v0.7.0 

type Service interface {
	Name() string
	Connect()
	Close()
	Connected() bool
}

type ServiceEvent added in v0.7.0 

type ServiceEvent struct {
	Name      string
	ErrStatus *status.Status
}

type Subscription added in v0.7.0 

type Subscription struct {
	TrackId   string
	Mute      bool
	Subscribe bool
	Layer     string
}

type Target added in v0.7.0 

type Target int32
const (
	Target_PUBLISHER  Target = 0
	Target_SUBSCRIBER Target = 1
)

type TrackEvent added in v0.7.0 

type TrackEvent struct {
	State  TrackEvent_State
	Uid    string
	Tracks []*TrackInfo
}

TrackEvent info

type TrackEvent_State added in v0.7.0 

type TrackEvent_State int32
const (
	TrackEvent_ADD    TrackEvent_State = 0
	TrackEvent_UPDATE TrackEvent_State = 1
	TrackEvent_REMOVE TrackEvent_State = 2
)

type TrackInfo added in v0.7.0 

type TrackInfo struct {
	Id        string
	Kind      string
	Muted     bool
	Type      MediaType
	StreamId  string
	Label     string
	Subscribe bool
	Layer     string
	Direction string
	Width     uint32
	Height    uint32
	FrameRate uint32
}

type Transport added in v0.2.0 

type Transport struct {
	SendCandidates []*webrtc.ICECandidate
	RecvCandidates []webrtc.ICECandidateInit
	// contains filtered or unexported fields
}

Transport is pub/sub transport

func NewTransport added in v0.2.0 

func NewTransport(role Target, rtc *RTC) *Transport

NewTransport create a transport

func (*Transport) GetPeerConnection added in v0.4.5 

func (t *Transport) GetPeerConnection() *webrtc.PeerConnection

type WebMProducer 

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

WebMProducer support streaming by webm which encode with vp8 and opus

func NewWebMProducer 

func NewWebMProducer(name string, offset int) *WebMProducer

NewWebMProducer new a WebMProducer

func (*WebMProducer) GetAudioTrack added in v0.7.0 

func (t *WebMProducer) GetAudioTrack() (*webrtc.TrackLocalStaticSample, error)

GetAudioTrack get audio track

func (*WebMProducer) GetSendBandwidth 

func (t *WebMProducer) GetSendBandwidth(cycle int) int

GetSendBandwidth calc the sending bandwidth with cycle(s)

func (*WebMProducer) GetVideoTrack added in v0.7.0 

func (t *WebMProducer) GetVideoTrack() (*webrtc.TrackLocalStaticSample, error)

GetVideoTrack get video track

func (*WebMProducer) Pause 

func (t *WebMProducer) Pause(pause bool)

func (*WebMProducer) SeekP 

func (t *WebMProducer) SeekP(ts int)

func (*WebMProducer) Start 

func (t *WebMProducer) Start()

func (*WebMProducer) Stop 

func (t *WebMProducer) Stop()

type WebRTCTransportConfig 

type WebRTCTransportConfig struct {
	VideoMime     string
	Configuration webrtc.Configuration
	Setting       webrtc.SettingEngine
}

WebRTCTransportConfig represents configuration options

Source Files

View all Source files

Directories

Path Synopsis
example
ion-cluster-simple
ion-sfu-gstreamer-receive
ion-sfu-gstreamer-send
ion-sfu-join-from-mediadevice
ion-sfu-load-tool
ion-sfu-save-to-disk
ion-sfu-save-to-webm
ion-sfu-simple
ion-sfu-track-to-rtp
pkg
grpc/biz
grpc/ion
gstreamer-sink
Package gst provides an easy API to create an appsrc pipeline
 Package gst provides an easy API to create an appsrc pipeline
gstreamer-src
Package gst provides an easy API to create an appsink pipeline
 Package gst provides an easy API to create an appsink pipeline

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.