Milestone SDK Mobile .Net
VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl > Class Template Referenceabstract

Main class for stream connection with 'Mobile Server'. More...

Inheritance diagram for VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl >:
VideoOS.Mobile.SDK.Portable.Server.Base.Stream< TParams, TCapabilities, TControl > VideoOS.Mobile.SDK.Portable.Server.Base.Video.IVideo VideoOS.Mobile.SDK.Portable.Server.Base.Video.IVideoSub VideoOS.Mobile.SDK.Portable.Server.Interfaces.IErrorResult VideoOS.Mobile.SDK.Portable.Server.Base.PlaybackStream< TParams, TCapabilities, TControl >

Public Member Functions

virtual void ExtendReconnectCommand (Command command)
 
void GetNextFrame ()
 Call it to force request of the nexr available frame.
 
override void Initialize (RequestStreamResponse response)
 
void Start ()
 
void Stop ()
 
- Public Member Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Base.Stream< TParams, TCapabilities, TControl >
void Dispose ()
 
void DisposeQuiet ()
 
void Reconnect ()
 
- Public Member Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Base.Video.IVideoSub

Protected Member Functions

override void Dispose (bool disposing, bool quiet)
 
override void OnFialedFrame ()
 
virtual void OnNewFrame (VideoFrame frame)
 
void OnSuccessChangeStream (BaseCommandResponse responseParams)
 
override void Reconnect (ReconnectSource source)
 
- Protected Member Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Base.Stream< TParams, TCapabilities, TControl >
bool FailedFramesThersholdPassed ()
 
bool FailedFramesThersholdReached ()
 
void IncrementFailedFramesCounter ()
 
void ProcessFrame (bool success)
 
void ResetFailedFramesCounter ()
 

Properties

OnVideoFrame NewFrame [get, set]
 Video frame callback.
 
TParams StreamParams [get]
 
- Properties inherited from VideoOS.Mobile.SDK.Portable.Server.Base.Stream< TParams, TCapabilities, TControl >
ICapabilities Capabilities [get]
 Raw capabilities provider.
 
TCapabilities DeviceCapabilities [get]
 Camera capabilities provider.
 
ErrorCodes ErrorCode [get]
 Returns error code (if presents) of the last call.
 
string ErrorMessage [get]
 Returns error string (if presents) of the last call.
 
Command.CommandResultTypes Result [get]
 Returns error status of the last call.
 
IStateChange StateChange [get]
 Interface allowing the client to subscribe for changes in the state of the stream (conencted/disconnected, etc.)
 
IStateChangeInternal StateChanger [get]
 
TControl StreamControl [get]
 VideoStreamControl object.
 
Guid StreamId [get]
 Gettting the video stream Id.
 
- Properties inherited from VideoOS.Mobile.SDK.Portable.Server.Interfaces.IErrorResult
- Properties inherited from VideoOS.Mobile.SDK.Portable.Server.Base.Video.IVideo

Additional Inherited Members

- Protected Attributes inherited from VideoOS.Mobile.SDK.Portable.Server.Base.Stream< TParams, TCapabilities, TControl >
readonly IConnection _iConnection
 
- Package Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Base.Stream< TParams, TCapabilities, TControl >

Detailed Description

Main class for stream connection with 'Mobile Server'.

Class for video connection with 'Mobile Server'. Supports 'HTTP'and 'HTTPS' connection types. Data is exposed through IVideo member OnVideoFrame NewFrame Should be disposed after finishing work with it.

Type Constraints
TParams :StreamParams 
TParams :new() 
TCapabilities :StreamingDeviceCapabilities 
TCapabilities :new() 
TControl :StreamControl<TParams> 

Member Function Documentation

◆ Dispose()

override void VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl >.Dispose ( bool disposing,
bool quiet )
inlineprotectedvirtual

◆ ExtendReconnectCommand()

virtual void VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl >.ExtendReconnectCommand ( Command command)
inlinevirtual

◆ GetNextFrame()

void VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl >.GetNextFrame ( )
inline

Call it to force request of the nexr available frame.

Implements VideoOS.Mobile.SDK.Portable.Server.Base.Video.IVideoSub.

◆ Initialize()

override void VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl >.Initialize ( RequestStreamResponse response)
inlinevirtual

◆ OnFialedFrame()

override void VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl >.OnFialedFrame ( )
inlineprotectedvirtual

◆ OnNewFrame()

virtual void VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl >.OnNewFrame ( VideoFrame frame)
inlineprotectedvirtual

◆ OnSuccessChangeStream()

void VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl >.OnSuccessChangeStream ( BaseCommandResponse responseParams)
inlineprotected

◆ Reconnect()

override void VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl >.Reconnect ( ReconnectSource source)
inlineprotectedvirtual

◆ Start()

void VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl >.Start ( )
inline

◆ Stop()

void VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl >.Stop ( )
inline

Property Documentation

◆ NewFrame

OnVideoFrame VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl >.NewFrame
getset

◆ StreamParams

TParams VideoOS.Mobile.SDK.Portable.Server.Base.Video.LiveStream< TParams, TCapabilities, TControl >.StreamParams
get