|
VNWinFormsPlayer
|
Windows Forms VideoNEXT media player control. More...
Public Member Functions | |
| SkmVideoPlayer () | |
| Constructor. More... | |
| void | Play (string url) |
| Starts video playback. More... | |
| void | Stop () |
| Puts the player in stopped state More... | |
| void | Resume (PlaybackDirection direction) |
| Resumes paused playback. More... | |
| void | GotoTime (DateTime time) |
| Sets position in a video. More... | |
| void | Pause () |
| Pauses playback. More... | |
| void | SaveSnapshot (string fileName) |
| Saves current frame to the file More... | |
| bool | SaveSnapshotUIPause () |
| Shows save dialog and saves snapshot. Video is paused while dialog is shown. More... | |
| bool | SaveSnapshotUI () |
| Shows save dialog and saves snapshot. More... | |
| void | SetPlaybackSpeed (double speed) |
| Sets playback speed. More... | |
| bool | StartRecording (string filename) |
| Starts video recording to a QuickTime Movie (MOV) file on a hard drive. More... | |
| bool | EndRecording () |
| Ends video recording started by StartRecording call. More... | |
| bool | StartRecordingUI () |
| Displays dialog for selection of video file name to start recording to and starts recording. More... | |
Protected Member Functions | |
| override void | OnResize (EventArgs e) |
| OnResize overridden method. More... | |
| override void | Dispose (bool disposing) |
| Clean up any resources being used. More... | |
Properties | |
| RendererType | Renderer [get, set] |
| Graphics renderer type. More... | |
| string[] | VisibleMetadata [get, set] |
| Visible metadata. More... | |
| TimeSpan | FrameTimeout [get, set] |
| The amount of time that needs to pass without getting a media sample, before a timeout occurs and the player is stopped More... | |
| DateTime? | CurrentTime [get, set] |
| The current time of the media player. More... | |
| RtpTransport | Transport [get, set] |
| The network transport that is used for the player More... | |
| uint | DropFrameInterval [get, set] |
| The drop frame interval, used to determine if a frame should not be rendered to save performance More... | |
| int | CacheSizeMegabytes [get, set] |
| Media player cache size in MB. More... | |
| StreamState | CurrentState [get] |
| The current play state of the player More... | |
| Size? | VideoSize [get, set] |
| Video size. More... | |
| bool | MaintainAspectRatio [get, set] |
| If true, the video will maintain the aspect ratio of the original video. Otherwise the video will stretch to the container's bounds. More... | |
| PixelFormat | Format [get, set] |
| The pixel format to use for the player (RGB 32 or RGB 24, RGB 32 is preferable). More... | |
| int | BufferLength [get, set] |
| Jitter buffer length in milliseconds. More... | |
| bool | IsPaused [get] |
| True if player is paused. More... | |
| bool | IsPlaying [get] |
| True if player is playing video. More... | |
| string | TimeFormat [get, set] |
| Format of time displayed in the video window. (.NET syntax). More... | |
| string | OnScreenDisplayFormat [get, set] |
| On screen display info template. The following placeholders can be used: {Name}, {Title}, {Time} and any key from CameraData dictionary. More... | |
| OnScreenDisplayPosition | OnScreenDisplayPosition [get, set] |
| On screen display info position in the video window. More... | |
| string | TimeZone [get, set] |
| Time zone name in IANA format. More... | |
| Dictionary< string, string >?? | CameraData [get, set] |
| Camera metadata. Can contain the following keys: Id, Name, TimeZone, PTZ, MD, Analytics, GeoLat, GeoLong, GeoAlt, Location, Note, AudioId, AudioName, etc. More... | |
| RecordingStatus | RecordingStatus [get] |
| Video recording to a local file status. More... | |
Events | |
| EventHandler< StreamStateChangedEventArgs > | CurrentStateChanged |
| Media player state changed event. More... | |
| EventHandler< ValueChangedEventArgs< DateTime > > | CurrentTimeChanged |
| Current frame time changed event. More... | |
| EventHandler< ValueChangedEventArgs< Size > > | VideoSizeChanged |
| Video size changed event. More... | |
| EventHandler< MessageLogEventArgs > | MessageLog |
| Media player info message arrived event. More... | |
| EventHandler< StreamEventArgs > | StreamAdded |
| Media stream added event (occurs on opening video source). More... | |
| EventHandler< StreamEventArgs > | StreamRemoved |
| Media stream removed event. More... | |
| EventHandler< RecordingStatusEventArgs > | RecordingStatusChanged |
| Recording to local video file status change event. More... | |
Windows Forms VideoNEXT media player control.
| VideoNext.WindowsForms.Player.SkmVideoPlayer.SkmVideoPlayer | ( | ) |
Constructor.
|
protected |
Clean up any resources being used.
| disposing | true if managed resources should be disposed; otherwise, false. |
| bool VideoNext.WindowsForms.Player.SkmVideoPlayer.EndRecording | ( | ) |
Ends video recording started by StartRecording call.
| void VideoNext.WindowsForms.Player.SkmVideoPlayer.GotoTime | ( | DateTime | time | ) |
Sets position in a video.
| time | frame time |
|
protected |
OnResize overridden method.
| e |
| void VideoNext.WindowsForms.Player.SkmVideoPlayer.Pause | ( | ) |
Pauses playback.
| void VideoNext.WindowsForms.Player.SkmVideoPlayer.Play | ( | string | url | ) |
Starts video playback.
| url | video source URL. For live or archive SkmXmlApi.Camera.GetLiveUrl or SkmXmlApi.Camera.GetArchiveUrl should be used to get URL, for file playback URL should be in format "file://full_path_to_file" |
| void VideoNext.WindowsForms.Player.SkmVideoPlayer.Resume | ( | PlaybackDirection | direction | ) |
Resumes paused playback.
| direction | playback direction |
| void VideoNext.WindowsForms.Player.SkmVideoPlayer.SaveSnapshot | ( | string | fileName | ) |
Saves current frame to the file
| fileName | File name to save image, extension used to select encoder (using JPEG by default) |
| bool VideoNext.WindowsForms.Player.SkmVideoPlayer.SaveSnapshotUI | ( | ) |
Shows save dialog and saves snapshot.
| bool VideoNext.WindowsForms.Player.SkmVideoPlayer.SaveSnapshotUIPause | ( | ) |
Shows save dialog and saves snapshot. Video is paused while dialog is shown.
| void VideoNext.WindowsForms.Player.SkmVideoPlayer.SetPlaybackSpeed | ( | double | speed | ) |
Sets playback speed.
| speed | 1 for normal speed, greater than 1 for fast play, less than 1 for slow play |
| bool VideoNext.WindowsForms.Player.SkmVideoPlayer.StartRecording | ( | string | filename | ) |
Starts video recording to a QuickTime Movie (MOV) file on a hard drive.
| filename | full path and name of file to write to |
| bool VideoNext.WindowsForms.Player.SkmVideoPlayer.StartRecordingUI | ( | ) |
Displays dialog for selection of video file name to start recording to and starts recording.
| void VideoNext.WindowsForms.Player.SkmVideoPlayer.Stop | ( | ) |
Puts the player in stopped state
|
getset |
Jitter buffer length in milliseconds.
|
getset |
Media player cache size in MB.
|
getset |
Camera metadata. Can contain the following keys: Id, Name, TimeZone, PTZ, MD, Analytics, GeoLat, GeoLong, GeoAlt, Location, Note, AudioId, AudioName, etc.
|
get |
The current play state of the player
|
getset |
The current time of the media player.
|
getset |
The drop frame interval, used to determine if a frame should not be rendered to save performance
|
getset |
The pixel format to use for the player (RGB 32 or RGB 24, RGB 32 is preferable).
|
getset |
The amount of time that needs to pass without getting a media sample, before a timeout occurs and the player is stopped
|
get |
True if player is paused.
|
get |
True if player is playing video.
|
getset |
If true, the video will maintain the aspect ratio of the original video. Otherwise the video will stretch to the container's bounds.
|
getset |
On screen display info template. The following placeholders can be used: {Name}, {Title}, {Time} and any key from CameraData dictionary.
|
getset |
On screen display info position in the video window.
|
get |
Video recording to a local file status.
|
getset |
Graphics renderer type.
|
getset |
Format of time displayed in the video window. (.NET syntax).
|
getset |
Time zone name in IANA format.
|
getset |
The network transport that is used for the player
|
getset |
Video size.
|
getset |
Visible metadata.
| EventHandler<StreamStateChangedEventArgs> VideoNext.WindowsForms.Player.SkmVideoPlayer.CurrentStateChanged |
Media player state changed event.
| EventHandler<ValueChangedEventArgs<DateTime> > VideoNext.WindowsForms.Player.SkmVideoPlayer.CurrentTimeChanged |
Current frame time changed event.
| EventHandler<MessageLogEventArgs> VideoNext.WindowsForms.Player.SkmVideoPlayer.MessageLog |
Media player info message arrived event.
| EventHandler<RecordingStatusEventArgs> VideoNext.WindowsForms.Player.SkmVideoPlayer.RecordingStatusChanged |
Recording to local video file status change event.
| EventHandler<StreamEventArgs> VideoNext.WindowsForms.Player.SkmVideoPlayer.StreamAdded |
Media stream added event (occurs on opening video source).
| EventHandler<StreamEventArgs> VideoNext.WindowsForms.Player.SkmVideoPlayer.StreamRemoved |
Media stream removed event.
| EventHandler<ValueChangedEventArgs<Size> > VideoNext.WindowsForms.Player.SkmVideoPlayer.VideoSizeChanged |
Video size changed event.