Interface IStream
Stream interface.
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public interface IStreamProperties
Direction
Gets the current direction.
Declaration
StreamDirection Direction { get; }Property Value
| Type | Description |
|---|---|
| StreamDirection |
ExternalId
Gets or sets the external identifier.
Declaration
string ExternalId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Id
Gets the identifier.
Declaration
string Id { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Label
Gets a label that identifies this class.
Declaration
string Label { get; }Property Value
| Type | Description |
|---|---|
| System.String |
LocalDirection
Gets or sets current direction indicated by the local description.
Declaration
StreamDirection LocalDirection { get; set; }Property Value
| Type | Description |
|---|---|
| StreamDirection |
LocalReceive
Gets or sets a value indicating whether receiving media is supported by the local peer on this stream.
Declaration
bool LocalReceive { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
LocalSend
Gets or sets a value indicating whether sending media is supported by the local peer on this stream.
Declaration
bool LocalSend { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
MediaDescriptionId
Gets the media description identifier.
Declaration
string MediaDescriptionId { get; }Property Value
| Type | Description |
|---|---|
| System.String |
RemoteDirection
Gets the current direction indicated by the remote description.
Declaration
StreamDirection RemoteDirection { get; }Property Value
| Type | Description |
|---|---|
| StreamDirection |
RemoteReceive
Gets or sets a value indicating whether receiving media is supported by the local peer on this stream. Returns false if the remote stream direction has not been received.
Declaration
bool RemoteReceive { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
RemoteSend
Gets a value indicating whether sending media is supported by the remote peer on this stream. Returns false if the remote stream direction has not been received.
Declaration
bool RemoteSend { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
State
Gets the current state.
Declaration
StreamState State { get; }Property Value
| Type | Description |
|---|---|
| StreamState |
Tag
Gets or sets optional data to associate with this instance.
Declaration
string Tag { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
TransportInfo
Gets the stream transport info.
Declaration
TransportInfo TransportInfo { get; }Property Value
| Type | Description |
|---|---|
| TransportInfo |
Type
Gets the type.
Declaration
StreamType Type { get; }Property Value
| Type | Description |
|---|---|
| StreamType |
Methods
ChangeDirection(StreamDirection)
Changes this stream's direction.
Declaration
Error ChangeDirection(StreamDirection newDirection)Parameters
| Type | Name | Description |
|---|---|---|
| StreamDirection | newDirection |
Returns
| Type | Description |
|---|---|
| Error |
Events
OnDirectionChange
Raised when the signalling state changes.
Declaration
event Action0 OnDirectionChangeEvent Type
| Type | Description |
|---|---|
| Action0 |
OnStateChange
Raised when the stream state changes.
Declaration
event Action0 OnStateChangeEvent Type
| Type | Description |
|---|---|
| Action0 |