Documentation
¶
Overview ¶
Package photongo is a generated protocol buffer package.
It is generated from these files:
PhotonCommands.proto
It has these top-level messages:
PhotonWrapper Connect Connect_Response Authenticate Authenticate_Response StartStream StreamStart_Response Heartbeat Heartbeat_Response Disconnect
Index ¶
- Variables
- type Authenticate
- type Authenticate_Response
- type Connect
- type Connect_Response
- func (*Connect_Response) Descriptor() ([]byte, []int)
- func (m *Connect_Response) GetHmacKey() string
- func (m *Connect_Response) GetServerProtocolVersion() ProtocolVersion
- func (m *Connect_Response) GetSessionId() uint64
- func (*Connect_Response) ProtoMessage()
- func (m *Connect_Response) Reset()
- func (m *Connect_Response) String() string
- type Disconnect
- type DisconnectReasons
- type Heartbeat
- type Heartbeat_Response
- type PhotonWrapper
- type ProtocolVersion
- type StartStream
- func (*StartStream) Descriptor() ([]byte, []int)
- func (m *StartStream) GetAudioCodec() string
- func (m *StartStream) GetAudioIngestSSRC() uint32
- func (m *StartStream) GetAudioPayloadType() uint32
- func (m *StartStream) GetHasAudio() bool
- func (m *StartStream) GetHasVideo() bool
- func (m *StartStream) GetVendorName() string
- func (m *StartStream) GetVendorVersion() string
- func (m *StartStream) GetVideoCodec() string
- func (m *StartStream) GetVideoHeight() uint32
- func (m *StartStream) GetVideoIngestSSRC() uint32
- func (m *StartStream) GetVideoPayloadType() uint32
- func (m *StartStream) GetVideoWidth() uint32
- func (*StartStream) ProtoMessage()
- func (m *StartStream) Reset()
- func (m *StartStream) String() string
- type StatusCodes
- type StreamStart_Response
Constants ¶
This section is empty.
Variables ¶
View Source
var DisconnectReasons_name = map[int32]string{
0: "DISCONNECT_UNKNOWN",
200: "CLIENT_CLEAN",
201: "INGEST_CLEAN",
300: "CLIENT_ERROR_UNKNOWN",
301: "CLIENT_ERROR_TIMEOUT",
302: "CLIENT_ERROR_BAD_RESPONSE",
400: "INGEST_ERROR_UNKNOWN",
401: "INGEST_ERROR_TIMEOUT",
}
View Source
var DisconnectReasons_value = map[string]int32{
"DISCONNECT_UNKNOWN": 0,
"CLIENT_CLEAN": 200,
"INGEST_CLEAN": 201,
"CLIENT_ERROR_UNKNOWN": 300,
"CLIENT_ERROR_TIMEOUT": 301,
"CLIENT_ERROR_BAD_RESPONSE": 302,
"INGEST_ERROR_UNKNOWN": 400,
"INGEST_ERROR_TIMEOUT": 401,
}
View Source
var ProtocolVersion_name = map[int32]string{
0: "NONE",
1: "V1",
}
View Source
var ProtocolVersion_value = map[string]int32{
"NONE": 0,
"V1": 1,
}
View Source
var StatusCodes_name = map[int32]string{
0: "UNKNOWN",
200: "OK",
201: "PING",
400: "BAD_REQUEST",
401: "UNAUTHORIZED",
402: "OLD_VERSION",
403: "NO_RESPONSE",
406: "INVALID_STREAM_KEY",
407: "CHANNEL_IN_USE",
408: "REGION_UNSUPPORTED",
409: "NO_MEDIA_TIMEOUT",
500: "INTERNAL_SERVER_ERROR",
501: "INTERNAL_COMMAND_ERROR",
502: "INTERNAL_LOCAL_ERROR",
}
View Source
var StatusCodes_value = map[string]int32{
"UNKNOWN": 0,
"OK": 200,
"PING": 201,
"BAD_REQUEST": 400,
"UNAUTHORIZED": 401,
"OLD_VERSION": 402,
"NO_RESPONSE": 403,
"INVALID_STREAM_KEY": 406,
"CHANNEL_IN_USE": 407,
"REGION_UNSUPPORTED": 408,
"NO_MEDIA_TIMEOUT": 409,
"INTERNAL_SERVER_ERROR": 500,
"INTERNAL_COMMAND_ERROR": 501,
"INTERNAL_LOCAL_ERROR": 502,
}
Functions ¶
This section is empty.
Types ¶
type Authenticate ¶
type Authenticate struct { ChannelId uint32 `protobuf:"varint,1,opt,name=ChannelId" json:"ChannelId,omitempty"` AuthKey string `protobuf:"bytes,2,opt,name=AuthKey" json:"AuthKey,omitempty"` }
func (*Authenticate) Descriptor ¶
func (*Authenticate) Descriptor() ([]byte, []int)
func (*Authenticate) GetAuthKey ¶
func (m *Authenticate) GetAuthKey() string
func (*Authenticate) GetChannelId ¶
func (m *Authenticate) GetChannelId() uint32
func (*Authenticate) ProtoMessage ¶
func (*Authenticate) ProtoMessage()
func (*Authenticate) Reset ¶
func (m *Authenticate) Reset()
func (*Authenticate) String ¶
func (m *Authenticate) String() string
type Authenticate_Response ¶
type Authenticate_Response struct { }
func (*Authenticate_Response) Descriptor ¶
func (*Authenticate_Response) Descriptor() ([]byte, []int)
func (*Authenticate_Response) ProtoMessage ¶
func (*Authenticate_Response) ProtoMessage()
func (*Authenticate_Response) Reset ¶
func (m *Authenticate_Response) Reset()
func (*Authenticate_Response) String ¶
func (m *Authenticate_Response) String() string
type Connect ¶
type Connect struct {
ClientProtocolVersion ProtocolVersion `` /* 126-byte string literal not displayed */
}
func (*Connect) Descriptor ¶
func (*Connect) GetClientProtocolVersion ¶
func (m *Connect) GetClientProtocolVersion() ProtocolVersion
func (*Connect) ProtoMessage ¶
func (*Connect) ProtoMessage()
type Connect_Response ¶
type Connect_Response struct { ServerProtocolVersion ProtocolVersion `` /* 126-byte string literal not displayed */ SessionId uint64 `protobuf:"varint,2,opt,name=SessionId" json:"SessionId,omitempty"` HmacKey string `protobuf:"bytes,3,opt,name=HmacKey" json:"HmacKey,omitempty"` }
func (*Connect_Response) Descriptor ¶
func (*Connect_Response) Descriptor() ([]byte, []int)
func (*Connect_Response) GetHmacKey ¶
func (m *Connect_Response) GetHmacKey() string
func (*Connect_Response) GetServerProtocolVersion ¶
func (m *Connect_Response) GetServerProtocolVersion() ProtocolVersion
func (*Connect_Response) GetSessionId ¶
func (m *Connect_Response) GetSessionId() uint64
func (*Connect_Response) ProtoMessage ¶
func (*Connect_Response) ProtoMessage()
func (*Connect_Response) Reset ¶
func (m *Connect_Response) Reset()
func (*Connect_Response) String ¶
func (m *Connect_Response) String() string
type Disconnect ¶
type Disconnect struct {
Reason DisconnectReasons `protobuf:"varint,1,opt,name=Reason,enum=Photon.Commands.DisconnectReasons" json:"Reason,omitempty"`
}
func (*Disconnect) Descriptor ¶
func (*Disconnect) Descriptor() ([]byte, []int)
func (*Disconnect) GetReason ¶
func (m *Disconnect) GetReason() DisconnectReasons
func (*Disconnect) ProtoMessage ¶
func (*Disconnect) ProtoMessage()
func (*Disconnect) Reset ¶
func (m *Disconnect) Reset()
func (*Disconnect) String ¶
func (m *Disconnect) String() string
type DisconnectReasons ¶
type DisconnectReasons int32
Reasons why the stream disconnected
const ( DisconnectReasons_DISCONNECT_UNKNOWN DisconnectReasons = 0 DisconnectReasons_CLIENT_CLEAN DisconnectReasons = 200 DisconnectReasons_INGEST_CLEAN DisconnectReasons = 201 DisconnectReasons_CLIENT_ERROR_UNKNOWN DisconnectReasons = 300 DisconnectReasons_CLIENT_ERROR_TIMEOUT DisconnectReasons = 301 DisconnectReasons_CLIENT_ERROR_BAD_RESPONSE DisconnectReasons = 302 DisconnectReasons_INGEST_ERROR_UNKNOWN DisconnectReasons = 400 DisconnectReasons_INGEST_ERROR_TIMEOUT DisconnectReasons = 401 )
func (DisconnectReasons) EnumDescriptor ¶
func (DisconnectReasons) EnumDescriptor() ([]byte, []int)
func (DisconnectReasons) String ¶
func (x DisconnectReasons) String() string
type Heartbeat ¶
type Heartbeat struct { }
func (*Heartbeat) Descriptor ¶
func (*Heartbeat) ProtoMessage ¶
func (*Heartbeat) ProtoMessage()
type Heartbeat_Response ¶
type Heartbeat_Response struct { }
func (*Heartbeat_Response) Descriptor ¶
func (*Heartbeat_Response) Descriptor() ([]byte, []int)
func (*Heartbeat_Response) ProtoMessage ¶
func (*Heartbeat_Response) ProtoMessage()
func (*Heartbeat_Response) Reset ¶
func (m *Heartbeat_Response) Reset()
func (*Heartbeat_Response) String ¶
func (m *Heartbeat_Response) String() string
type PhotonWrapper ¶
type PhotonWrapper struct { StatusCode StatusCodes `protobuf:"varint,1,opt,name=StatusCode,enum=Photon.Commands.StatusCodes" json:"StatusCode,omitempty"` Command *google_protobuf.Any `protobuf:"bytes,15,opt,name=Command" json:"Command,omitempty"` }
func (*PhotonWrapper) Descriptor ¶
func (*PhotonWrapper) Descriptor() ([]byte, []int)
func (*PhotonWrapper) GetCommand ¶
func (m *PhotonWrapper) GetCommand() *google_protobuf.Any
func (*PhotonWrapper) GetStatusCode ¶
func (m *PhotonWrapper) GetStatusCode() StatusCodes
func (*PhotonWrapper) ProtoMessage ¶
func (*PhotonWrapper) ProtoMessage()
func (*PhotonWrapper) Reset ¶
func (m *PhotonWrapper) Reset()
func (*PhotonWrapper) String ¶
func (m *PhotonWrapper) String() string
type ProtocolVersion ¶
type ProtocolVersion int32
const ( ProtocolVersion_NONE ProtocolVersion = 0 ProtocolVersion_V1 ProtocolVersion = 1 )
func (ProtocolVersion) EnumDescriptor ¶
func (ProtocolVersion) EnumDescriptor() ([]byte, []int)
func (ProtocolVersion) String ¶
func (x ProtocolVersion) String() string
type StartStream ¶
type StartStream struct { VendorName string `protobuf:"bytes,1,opt,name=VendorName" json:"VendorName,omitempty"` VendorVersion string `protobuf:"bytes,2,opt,name=VendorVersion" json:"VendorVersion,omitempty"` // Video Params HasVideo bool `protobuf:"varint,10,opt,name=HasVideo" json:"HasVideo,omitempty"` VideoCodec string `protobuf:"bytes,11,opt,name=VideoCodec" json:"VideoCodec,omitempty"` VideoHeight uint32 `protobuf:"varint,12,opt,name=VideoHeight" json:"VideoHeight,omitempty"` VideoWidth uint32 `protobuf:"varint,13,opt,name=VideoWidth" json:"VideoWidth,omitempty"` VideoPayloadType uint32 `protobuf:"varint,14,opt,name=VideoPayloadType" json:"VideoPayloadType,omitempty"` VideoIngestSSRC uint32 `protobuf:"varint,15,opt,name=VideoIngestSSRC" json:"VideoIngestSSRC,omitempty"` // Audio Params HasAudio bool `protobuf:"varint,30,opt,name=HasAudio" json:"HasAudio,omitempty"` AudioCodec string `protobuf:"bytes,31,opt,name=AudioCodec" json:"AudioCodec,omitempty"` AudioPayloadType uint32 `protobuf:"varint,32,opt,name=AudioPayloadType" json:"AudioPayloadType,omitempty"` AudioIngestSSRC uint32 `protobuf:"varint,33,opt,name=AudioIngestSSRC" json:"AudioIngestSSRC,omitempty"` }
func (*StartStream) Descriptor ¶
func (*StartStream) Descriptor() ([]byte, []int)
func (*StartStream) GetAudioCodec ¶
func (m *StartStream) GetAudioCodec() string
func (*StartStream) GetAudioIngestSSRC ¶
func (m *StartStream) GetAudioIngestSSRC() uint32
func (*StartStream) GetAudioPayloadType ¶
func (m *StartStream) GetAudioPayloadType() uint32
func (*StartStream) GetHasAudio ¶
func (m *StartStream) GetHasAudio() bool
func (*StartStream) GetHasVideo ¶
func (m *StartStream) GetHasVideo() bool
func (*StartStream) GetVendorName ¶
func (m *StartStream) GetVendorName() string
func (*StartStream) GetVendorVersion ¶
func (m *StartStream) GetVendorVersion() string
func (*StartStream) GetVideoCodec ¶
func (m *StartStream) GetVideoCodec() string
func (*StartStream) GetVideoHeight ¶
func (m *StartStream) GetVideoHeight() uint32
func (*StartStream) GetVideoIngestSSRC ¶
func (m *StartStream) GetVideoIngestSSRC() uint32
func (*StartStream) GetVideoPayloadType ¶
func (m *StartStream) GetVideoPayloadType() uint32
func (*StartStream) GetVideoWidth ¶
func (m *StartStream) GetVideoWidth() uint32
func (*StartStream) ProtoMessage ¶
func (*StartStream) ProtoMessage()
func (*StartStream) Reset ¶
func (m *StartStream) Reset()
func (*StartStream) String ¶
func (m *StartStream) String() string
type StatusCodes ¶
type StatusCodes int32
Codes that can be set on any command
const ( StatusCodes_UNKNOWN StatusCodes = 0 StatusCodes_OK StatusCodes = 200 StatusCodes_PING StatusCodes = 201 StatusCodes_BAD_REQUEST StatusCodes = 400 StatusCodes_UNAUTHORIZED StatusCodes = 401 StatusCodes_OLD_VERSION StatusCodes = 402 StatusCodes_NO_RESPONSE StatusCodes = 403 StatusCodes_INVALID_STREAM_KEY StatusCodes = 406 StatusCodes_CHANNEL_IN_USE StatusCodes = 407 StatusCodes_REGION_UNSUPPORTED StatusCodes = 408 StatusCodes_NO_MEDIA_TIMEOUT StatusCodes = 409 StatusCodes_INTERNAL_SERVER_ERROR StatusCodes = 500 StatusCodes_INTERNAL_COMMAND_ERROR StatusCodes = 501 StatusCodes_INTERNAL_LOCAL_ERROR StatusCodes = 502 )
func (StatusCodes) EnumDescriptor ¶
func (StatusCodes) EnumDescriptor() ([]byte, []int)
func (StatusCodes) String ¶
func (x StatusCodes) String() string
type StreamStart_Response ¶
type StreamStart_Response struct {
IngestPort uint32 `protobuf:"varint,1,opt,name=IngestPort" json:"IngestPort,omitempty"`
}
func (*StreamStart_Response) Descriptor ¶
func (*StreamStart_Response) Descriptor() ([]byte, []int)
func (*StreamStart_Response) GetIngestPort ¶
func (m *StreamStart_Response) GetIngestPort() uint32
func (*StreamStart_Response) ProtoMessage ¶
func (*StreamStart_Response) ProtoMessage()
func (*StreamStart_Response) Reset ¶
func (m *StreamStart_Response) Reset()
func (*StreamStart_Response) String ¶
func (m *StreamStart_Response) String() string
Click to show internal directories.
Click to hide internal directories.