VideoCapture (JxCapture 3.7)

java.lang.Object
- com.teamdev.jxcapture.CaptureBase
- - com.teamdev.jxcapture.VideoCapture

Direct Known Subclasses:

BaseDirectShowCapture, LinuxVideoCapture, LionVideoCapture, SnowLeopardVideoCapture
```
public abstract class VideoCapture
extends CaptureBase
```
Base class that defines the video capture API.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String PROPERTY_AUDIO_SOURCE

static java.lang.String PROPERTY_FRAMERATE

static java.lang.String PROPERTY_VIDEO_SOURCE
- Fields inherited from class com.teamdev.jxcapture.CaptureBase
  PROPERTY_CAPTURE_AREA, PROPERTY_CAPTURE_TRANSPARENT_WINDOWS, PROPERTY_INCLUDE_CURSOR

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROPERTY_AUDIO_SOURCE`
`static java.lang.String`	`PROPERTY_FRAMERATE`
`static java.lang.String`	`PROPERTY_VIDEO_SOURCE`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`VideoCapture()` Creates new video capture.
`protected`	`VideoCapture(VideoSource source)` Creates new video capture for the specified video source.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static VideoCapture`	`create()` Constructs video capture object for a native video format.
`static VideoCapture`	`create(VideoFormat videoFormat)` Constructs video capture instance object for the specified video format.
`protected abstract void`	`doPause()` Performs the steps required to pause a video capture process.
`protected abstract void`	`doStart()` Performs the steps required to start a video capture process.
`protected abstract void`	`doStop()` Performs the steps required to stop a video capture process.
`abstract java.util.List<AudioCodec>`	`getAudioCodecs()` Returns the list of audio codecs that this video capture can provide.
`AudioSource`	`getAudioSource()` Returns the specified audio source.
`static java.util.List<VideoFormat>`	`getAvailableFormats()` Returns the list of available video formats for a current platform.
`EncodingParameters`	`getEncodingParameters()` Returns the specified encoding settings.
`Framerate`	`getFramerate()` Returns the specified screen capture framerate in FPS units.
`abstract java.util.List<Codec>`	`getVideoCodecs()` Returns the list of video codecs that this video capture can provide.
`abstract VideoFormat`	`getVideoFormat()` Returns the video format that this video capture provides.
`VideoSource`	`getVideoSource()` Returns the specified video source.
`static boolean`	`isAvailable()` Checks whether video capture is supported for the current architecture and OS version
`boolean`	`isStarted()` Returns the state of this video capture.
`void`	`pause()` Pauses current video capturing process.
`void`	`setAudioSource(AudioSource audioSource)` Specifies new audio source for recording.
`void`	`setEncodingParameters(EncodingParameters encodingParameters)` Set the encoding parameters.
`void`	`setFramerate(Framerate value)` Specifies a required screen capture framerate in frames per second (FPS) units.
`void`	`setFramerate(int value)` Specifies a required screen capture framerate in frames per second (FPS) units.
`void`	`setVideoSource(VideoSource videoSource)` Specifies video source for recording.
`void`	`start()` Starts this video capture asynchronously.
`void`	`start(EncodingParameters encodingParameters)` Starts this video capture asynchronously.
`void`	`stop()` Stops a video capture process.
`protected void`	`validate(EncodingParameters encodingParameters)` Validates encoding settings.

Methods inherited from class com.teamdev.jxcapture.CaptureBase
addPropertyChangeListener, addPropertyChangeListener, getCaptureArea, getPropertyChangeSupport, isCaptureTransparentWindows, isIncludeCursor, removePropertyChangeListener, setCaptureArea, setCaptureTransparentWindows, setIncludeCursor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROPERTY_FRAMERATE
```
public static final java.lang.String PROPERTY_FRAMERATE
```
    See Also:
    
    Constant Field Values
  - PROPERTY_VIDEO_SOURCE
```
public static final java.lang.String PROPERTY_VIDEO_SOURCE
```
    See Also:
    
    Constant Field Values
  - PROPERTY_AUDIO_SOURCE
```
public static final java.lang.String PROPERTY_AUDIO_SOURCE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - VideoCapture
```
protected VideoCapture()
```
    Creates new video capture.
  - VideoCapture
```
protected VideoCapture(VideoSource source)
```
    Creates new video capture for the specified video source.
    
    Parameters:
    
    source - video source
- Method Detail
  - isStarted
```
public boolean isStarted()
```
    Returns the state of this video capture.
    
    Returns:
    
    true if it's already started; false otherwise;
  - getEncodingParameters
```
public EncodingParameters getEncodingParameters()
```
    Returns the specified encoding settings.
    
    Returns:
    
    encoding settings
  - setEncodingParameters
```
public void setEncodingParameters(EncodingParameters encodingParameters)
```
    Set the encoding parameters.
    
    Parameters:
    
    encodingParameters - parameter for encoding
  - getFramerate
```
public Framerate getFramerate()
```
    Returns the specified screen capture framerate in FPS units.
    
    Returns:
    
    specified screen capture framerate
  - setFramerate
```
public void setFramerate(int value)
```
    Specifies a required screen capture framerate in frames per second (FPS) units.
    The specified frame rate must be in range defined by Framerate.MIN and Framerate.MAX constant, or Framerate.ACTUAL which defines an actual capture frame rate.
    
    Parameters:
    
    value - required frame rate value that must be in range [Framerate.MIN - Framerate.MAX]
    
    Throws:
    
    java.lang.IllegalArgumentException - if specified framerate is not valid
  - setFramerate
```
public void setFramerate(Framerate value)
```
    Specifies a required screen capture framerate in frames per second (FPS) units.
    
    Parameters:
    
    value - required frame rate value
  - start
```
public final void start(EncodingParameters encodingParameters)
```
    Starts this video capture asynchronously.
    
    Parameters:
    
    encodingParameters - encoding parameters
  - start
```
public final void start()
```
    Starts this video capture asynchronously.
  - validate
```
protected void validate(EncodingParameters encodingParameters)
```
    Validates encoding settings.
    
    Parameters:
    
    encodingParameters - specifies video encoding settings
  - doStart
```
protected abstract void doStart()
```
    Performs the steps required to start a video capture process.
  - stop
```
public final void stop()
```
    Stops a video capture process.
  - pause
```
public final void pause()
```
    Pauses current video capturing process.
  - doPause
```
protected abstract void doPause()
```
    Performs the steps required to pause a video capture process.
  - doStop
```
protected abstract void doStop()
```
    Performs the steps required to stop a video capture process.
  - getVideoFormat
```
public abstract VideoFormat getVideoFormat()
```
    Returns the video format that this video capture provides.
    
    Returns:
    
    video format provided by this video capture
  - getVideoCodecs
```
public abstract java.util.List<Codec> getVideoCodecs()
```
    Returns the list of video codecs that this video capture can provide.
    
    Returns:
    
    list of Codec objects.
  - getAudioCodecs
```
public abstract java.util.List<AudioCodec> getAudioCodecs()
```
    Returns the list of audio codecs that this video capture can provide.
    
    Returns:
    
    list of Codec objects.
  - create
```
public static VideoCapture create(VideoFormat videoFormat)
```
    Constructs video capture instance object for the specified video format.
    
    Parameters:
    
    videoFormat - specifies the required video format
    
    Returns:
    
    a video capture instance; null if no appropriate video capture found for the specified video format
  - create
```
public static VideoCapture create()
```
    Constructs video capture object for a native video format.
    
    Returns:
    
    a video capture instance; null if no appropriate video capture implementation is found for the specified video format
  - getAvailableFormats
```
public static java.util.List<VideoFormat> getAvailableFormats()
```
    Returns the list of available video formats for a current platform.
    
    Returns:
    
    list of VideoFormat objects
  - getAudioSource
```
public AudioSource getAudioSource()
```
    Returns the specified audio source.
    
    Returns:
    
    audio source
  - setAudioSource
```
public void setAudioSource(AudioSource audioSource)
```
    Specifies new audio source for recording.
    
    Parameters:
    
    audioSource - new audio source; null is allowed value
  - getVideoSource
```
public VideoSource getVideoSource()
```
    Returns the specified video source.
    
    Returns:
    
    video source
  - setVideoSource
```
public void setVideoSource(VideoSource videoSource)
```
    Specifies video source for recording.
    
    Parameters:
    
    videoSource - new video source
  - isAvailable
```
public static boolean isAvailable()
```
    Checks whether video capture is supported for the current architecture and OS version
    
    Returns:
    
    possibility of video capture

Class VideoCapture

Field Summary

Fields inherited from class com.teamdev.jxcapture.CaptureBase

Constructor Summary

Method Summary

Methods inherited from class com.teamdev.jxcapture.CaptureBase

Methods inherited from class java.lang.Object

Field Detail

PROPERTY_FRAMERATE

PROPERTY_VIDEO_SOURCE

PROPERTY_AUDIO_SOURCE

Constructor Detail

VideoCapture

VideoCapture

Method Detail

isStarted

getEncodingParameters

setEncodingParameters

getFramerate

setFramerate

setFramerate

start

start

validate

doStart

stop

pause

doPause

doStop

getVideoFormat

getVideoCodecs

getAudioCodecs

create

create

getAvailableFormats

getAudioSource

setAudioSource

getVideoSource

setVideoSource

isAvailable