Class ScreenMirroring

Definition

Namespace:
Tizen.Multimedia.Remoting
Assembly:
Tizen.Multimedia.Remoting.dll

Provides the ability to connect to and disconnect from a screen mirroring source, start, pause, and resume the screen mirroring as a sink.

public class ScreenMirroring : IDisposable
Inheritance
object
ScreenMirroring
Implements
System.IDisposable

Constructors

View Source

ScreenMirroring()

Initializes a new instance of the ScreenMirroring class.

Declaration
public ScreenMirroring()
Exceptions
Type Condition
System.NotSupportedException

The feature is not supported.

Properties

View Source

AudioInfo

Gets the negotiated audio info.

Declaration
public ScreenMirroringAudioInfo AudioInfo { get; }
Property Value
Type Description
ScreenMirroringAudioInfo
View Source

DisplayMode

Gets or sets the display mode.

Declaration
public ScreenMirroringDisplayMode DisplayMode { get; set; }
Property Value
Type Description
ScreenMirroringDisplayMode
Exceptions
Type Condition
System.ObjectDisposedException

The ScreenMirroring has already been disposed.
View Source

DisplayRoi

Gets or sets the display position and size of the receiver screen view.

Declaration
public Rectangle DisplayRoi { get; set; }
Property Value
Type Description
Rectangle
Remarks

DisplayRoi will be applied when DisplayMode is CustomRoi.

Exceptions
Type Condition
System.ArgumentOutOfRangeException

DisplayRoi.X or DisplayRoi.Y is less than 0.
-or-
DisplayRoi.Width or DisplayRoi.Height is less than or equal to 0.
System.ObjectDisposedException

The ScreenMirroring has already been disposed.
See Also
View Source

DisplayRotation

Gets or sets the display rotation.

Declaration
public Rotation DisplayRotation { get; set; }
Property Value
Type Description
Rotation
Exceptions
Type Condition
System.ObjectDisposedException

The ScreenMirroring has already been disposed.
View Source

SourceDeviceType

Gets or sets the source device type.

Declaration
public ScreenMirroringDeviceType SourceDeviceType { get; set; }
Property Value
Type Description
ScreenMirroringDeviceType
Exceptions
Type Condition
System.ObjectDisposedException

The ScreenMirroring has already been disposed.
View Source

VideoInfo

Gets the negotiated video info.

Declaration
public ScreenMirroringVideoInfo VideoInfo { get; }
Property Value
Type Description
ScreenMirroringVideoInfo

Methods

View Source

ConnectAsync(string, uint)

Creates the connection and ready for receiving data from a mirroring source with the given port.

Declaration
public Task ConnectAsync(string sourceIp, uint port)
Parameters
Type Name Description
string sourceIp

The source ip address to connect.
uint port

The port number to connect. The max value is 65535.
Returns
Type Description
System.Threading.Tasks.Task

A task that represents the asynchronous operation.
Remarks

The state must be Prepared state by Prepare(Display, ScreenMirroringResolutions).

Exceptions
Type Condition
System.ArgumentException

sourceIp is a zero-length string, contains only white space.
System.ArgumentNullException

sourceIp is null.
System.ArgumentOutOfRangeException

port is greater than port max value(65535).
System.InvalidOperationException

The current state is not in the valid.
-or-
An internal error occurs.
System.ObjectDisposedException

The ScreenMirroring has already been disposed.
System.UnauthorizedAccessException

Caller does not have required permission.
View Source

ConnectAsync(string)

Creates the connection and ready for receiving data from a mirroring source.

Declaration
public Task ConnectAsync(string sourceIp)
Parameters
Type Name Description
string sourceIp

The source ip address to connect.
Returns
Type Description
System.Threading.Tasks.Task

A task that represents the asynchronous operation.
Remarks

The state must be Prepared state by Prepare(Display, ScreenMirroringResolutions).
The default port number is 2022.
If you want to connect using different port number, please use ConnectAsync(string, uint).

Exceptions
Type Condition
System.ArgumentException

sourceIp is a zero-length string, contains only white space.
System.ArgumentNullException

sourceIp is null.
System.InvalidOperationException

The current state is not in the valid.
-or-
An internal error occurs.
System.ObjectDisposedException

The ScreenMirroring has already been disposed.
System.UnauthorizedAccessException

Caller does not have required permission.
See Also
View Source

Disconnect()

Disconnects from the source.

Declaration
public void Disconnect()
Remarks

The state must be Connected, Playing or Paused.

Exceptions
Type Condition
System.InvalidOperationException

The current state is not in the valid.
-or-
An internal error occurs.
System.ObjectDisposedException

The ScreenMirroring has already been disposed.
System.UnauthorizedAccessException

Caller does not have required permission.
View Source

Dispose()

Releases all resource used by the ScreenMirroring object.

Declaration
public void Dispose()
Remarks

Call Dispose() when you are finished using the ScreenMirroring. The Dispose() method leaves the ScreenMirroring in an unusable state. After calling Dispose(), you must release all references to the ScreenMirroring so the garbage collector can reclaim the memory that the ScreenMirroring was occupying.

View Source

Dispose(bool)

Releases the resources used by the ScreenMirroring.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
View Source

~ScreenMirroring()

Finalizes an instance of the ScreenMirroring class.

Declaration
protected ~ScreenMirroring()
View Source

PauseAsync()

Pauses mirroring from the source.

Declaration
public Task PauseAsync()
Returns
Type Description
System.Threading.Tasks.Task

A task that represents the asynchronous operation.
Remarks

The state must be Playing state by StartAsync().

Exceptions
Type Condition
System.InvalidOperationException

The current state is not in the valid.
-or-
An internal error occurs.
System.ObjectDisposedException

The ScreenMirroring has already been disposed.
System.UnauthorizedAccessException

Caller does not have required permission.
View Source

Prepare(Display, ScreenMirroringResolutions)

Prepares the screen mirroring with the specified display and resolutions.

Declaration
public void Prepare(Display display, ScreenMirroringResolutions resolutions)
Parameters
Type Name Description
Display display

The display where the mirroring will be played on.
ScreenMirroringResolutions resolutions

The desired resolutions.
Remarks

The state must be Idle.

Exceptions
Type Condition
System.ArgumentException

resolutions contain invalid flags.
-or-
display has already been assigned to another.
System.ArgumentNullException

display is null.
System.InvalidOperationException

The current state is not in the valid.
-or-
An internal error occurs.
System.ObjectDisposedException

The ScreenMirroring has already been disposed.
View Source

Prepare(Display)

Prepares the screen mirroring with the specified display.

Declaration
public void Prepare(Display display)
Parameters
Type Name Description
Display display

The display where the mirroring will be played on.
Remarks

The state must be Idle.

All supported resolutions will be candidates.

Exceptions
Type Condition
System.ArgumentException

display has already been assigned to another.
System.ArgumentNullException

display is null.
System.InvalidOperationException

The current state is not in the valid.
-or-
An internal error occurs.
System.ObjectDisposedException

The ScreenMirroring has already been disposed.
View Source

ResumeAsync()

Resumes mirroring from the source.

Declaration
public Task ResumeAsync()
Returns
Type Description
System.Threading.Tasks.Task

A task that represents the asynchronous operation.
Remarks

The state must be Paused state by PauseAsync().

Exceptions
Type Condition
System.InvalidOperationException

The current state is not in the valid.
-or-
An internal error occurs.
System.ObjectDisposedException

The ScreenMirroring has already been disposed.
System.UnauthorizedAccessException

Caller does not have required permission.
View Source

StartAsync()

Starts mirroring from the source.

Declaration
public Task StartAsync()
Returns
Type Description
System.Threading.Tasks.Task

A task that represents the asynchronous operation.
Remarks

The state must be Connected state by ConnectAsync(string).

Exceptions
Type Condition
System.InvalidOperationException

The current state is not in the valid.
-or-
An internal error occurs.
System.ObjectDisposedException

The ScreenMirroring has already been disposed.
System.UnauthorizedAccessException

Caller does not have required permission.
View Source

Unprepare()

Unprepares the screen mirroring.

Declaration
public void Unprepare()
Remarks

The state must be Prepared, or Disconnected.

Exceptions
Type Condition
System.InvalidOperationException

The current state is not in the valid.
-or-
An internal error occurs.
System.ObjectDisposedException

The ScreenMirroring has already been disposed.

Events

View Source

ErrorOccurred

Occurs when an error occurs.

Declaration
public event EventHandler<ScreenMirroringErrorOccurredEventArgs> ErrorOccurred
Event Type
Type Description
System.EventHandler<TEventArgs><ScreenMirroringErrorOccurredEventArgs>
View Source

StateChanged

Occurs when the state is changed.

Declaration
public event EventHandler<ScreenMirroringStateChangedEventArgs> StateChanged
Event Type
Type Description
System.EventHandler<TEventArgs><ScreenMirroringStateChangedEventArgs>

Implements

System.IDisposable