Class ScreenSource
A .NET-based screen capture provider.
Inheritance
System.Object
    
    
    
    MediaSource<IVideoOutput, IVideoInput, IVideoInputCollection, VideoSource, VideoFrame, VideoBuffer, VideoBufferCollection, VideoFormat>
    
    
    ScreenSource
  Implements
Inherited Members
      System.Object.ToString()
    
    
      System.Object.Equals(System.Object)
    
    
      System.Object.Equals(System.Object, System.Object)
    
    
      System.Object.ReferenceEquals(System.Object, System.Object)
    
    
      System.Object.GetHashCode()
    
    
      System.Object.GetType()
    
    
      System.Object.MemberwiseClone()
    
  Namespace: FM.LiveSwitch.WinForms
Assembly: FM.LiveSwitch.WinForms.dll
Syntax
public class ScreenSource : ScreenSourceBase, IVideoOutput, IMediaOutput<IVideoOutput, IVideoInput, VideoFrame, VideoBuffer, VideoBufferCollection, VideoFormat>, IOutput<IVideoOutput, IVideoInput, VideoFrame, VideoBuffer, VideoBufferCollection, VideoFormat>, IVideoElement, IMediaElement, IElement
  Constructors
ScreenSource(Rectangle, Double)
Initializes a new instance of the ScreenSource class.
Declaration
public ScreenSource(Rectangle targetRegion, double targetFrameRate)
  Parameters
| Type | Name | Description | 
|---|---|---|
| Rectangle | targetRegion | The target region.  | 
      
| System.Double | targetFrameRate | The target frame rate.  | 
      
ScreenSource(ScreenConfig)
Initializes a new instance of the ScreenSource class.
Declaration
public ScreenSource(ScreenConfig targetConfig)
  Parameters
| Type | Name | Description | 
|---|---|---|
| ScreenConfig | targetConfig | The target configuration.  | 
      
ScreenSource(Double)
Initializes a new instance of the ScreenSource class.
Declaration
public ScreenSource(double targetFrameRate)
  Parameters
| Type | Name | Description | 
|---|---|---|
| System.Double | targetFrameRate | The target frame rate.  | 
      
Properties
Api
Gets the current API.
Declaration
public ScreenSourceApi Api { get; }
  Property Value
| Type | Description | 
|---|---|
| ScreenSourceApi | 
Label
Gets a label that identifies this class.
Declaration
public override string Label { get; }
  Property Value
| Type | Description | 
|---|---|
| System.String | 
Overrides
FM.LiveSwitch.MediaSource<FM.LiveSwitch.IVideoOutput, FM.LiveSwitch.IVideoInput, FM.LiveSwitch.IVideoInputCollection, FM.LiveSwitch.VideoSource, FM.LiveSwitch.VideoFrame, FM.LiveSwitch.VideoBuffer, FM.LiveSwitch.VideoBufferCollection, FM.LiveSwitch.VideoFormat>.Label
  
  TargetApi
Gets or sets the target API.
Declaration
public ScreenSourceApi TargetApi { get; set; }
  Property Value
| Type | Description | 
|---|---|
| ScreenSourceApi | 
Methods
DoStart()
Starts this instance.
Declaration
protected override Future<object> DoStart()
  Returns
| Type | Description | 
|---|---|
| Future<System.Object> | 
Overrides
FM.LiveSwitch.MediaSource<FM.LiveSwitch.IVideoOutput, FM.LiveSwitch.IVideoInput, FM.LiveSwitch.IVideoInputCollection, FM.LiveSwitch.VideoSource, FM.LiveSwitch.VideoFrame, FM.LiveSwitch.VideoBuffer, FM.LiveSwitch.VideoBufferCollection, FM.LiveSwitch.VideoFormat>.DoStart()
  
  DoStop()
Stops this instance.
Declaration
protected override Future<object> DoStop()
  Returns
| Type | Description | 
|---|---|
| Future<System.Object> | 
Overrides
FM.LiveSwitch.MediaSource<FM.LiveSwitch.IVideoOutput, FM.LiveSwitch.IVideoInput, FM.LiveSwitch.IVideoInputCollection, FM.LiveSwitch.VideoSource, FM.LiveSwitch.VideoFrame, FM.LiveSwitch.VideoBuffer, FM.LiveSwitch.VideoBufferCollection, FM.LiveSwitch.VideoFormat>.DoStop()
  
  GetInputs()
Gets the available inputs.
Declaration
public override Future<SourceInput[]> GetInputs()
  Returns
| Type | Description | 
|---|---|
| Future<SourceInput[]> | 
Overrides
FM.LiveSwitch.MediaSource<FM.LiveSwitch.IVideoOutput, FM.LiveSwitch.IVideoInput, FM.LiveSwitch.IVideoInputCollection, FM.LiveSwitch.VideoSource, FM.LiveSwitch.VideoFrame, FM.LiveSwitch.VideoBuffer, FM.LiveSwitch.VideoBufferCollection, FM.LiveSwitch.VideoFormat>.GetInputs()