←Select platform
In This Topic ▼

PlayCtrl Class Members

Summary

The following tables list the members exposed by PlayCtrl.

Public Constructors

Name Description
Public Constructor PlayCtrl The PlayCtrl control object constructor.

Public Methods

Name Description
Public Method CanSaveObjectSettings Determines whether the specified settings can be saved.
Public Method CheckSeekingCapabilities Specifies whether the object is capable of performing the specified seeking operation.
Public Method EditGraph Registers the current graph and runs the DirectShow GraphEdit utility.
Public Method GetPreferredFilter Retrieves the preferred filter's Display Name set using the SetPreferredFilter method.
Public Method GetSelectedStream Gets the index of the selected stream of type streamType.
Public Method GetStillDIB Gets a device-independent bitmap (DIB).
Public Method GetStillImage Gets a System.Drawing.Image object.
Public Method GetStreamCount Gets the number of elementary streams
Public Method GetSubObject Gets the specified graph object.
Public Method HasDialog Checks whether the specified property dialog is available.
Public Method IsRateSupported Determines whether a specific playback rate is supported.
Public Method LoadSettingsFromFile Loads some or all of the play object settings from a file.
Public Method LoadSettingsFromStream Loads settings from a stream.
Public Method MarkSelectionEnd Sets the selection ending mark equal to the current position.
Public Method MarkSelectionStart Sets the selection starting mark equal to the current position.
Public Method NextFrame Seeks to the next video frame.
Public Method Pause Pauses the current media file playback.
Public Method PreviousFrame Seeks for the previous video frame.
Public Method ResetSource Resets the media source.
Public Method Run Plays the current media source.
Public Method SaveSettingsToFile Saves some or all of the play object settings to a file.
Public Method SaveSettingsToStream Saves some or all of the play object settings to a stream.
Public Method SaveStillBitmap Saves a snapshot from the running stream to a file as a bitmap.
Public Method SaveStillDIB Saves a snapshot from the running stream to a file as a Device Independent Bitmap (DIB).
Public Method Scrub Forces a frame to the renderer while stopped.
Public Method SeekEnd Seeks for the end of the media file.
Public Method SeekSelectionEnd Seeks for the ending mark of the selection.
Public Method SeekSelectionStart Seeks for the starting mark for the selection.
Public Method SeekStart Seeks for the beginning of the media file.
Public Method SetPreferredFilter Sets a preferred filter (decoder or demultiplexer)
Public Method SetSelectedStream Indicates which stream of type streamType should be selected (rendered).
Public Method SetVideoWindowPos Sets the position and size of the video window.
Public Method ShowDialog Displays the specified property dialog.
Public Method Stop Stops the current media file playback.
Public Method ToggleClosedCaptioning Switches the state of the closed captioning mode on or off.
Public Method ToggleFullScreenMode Switches the full screen mode on or off.

Protected Methods

Name Description
Protected Method AttachInterfaces Internal method to attach interfaces to the underlying control object.
Protected Method CreateSink Internal method to create the event sink for the underlying control object.
Protected Method DetachSink Internal method to detach the event sink for the underlying control object.
Protected Method Dispose Releases internal control object and related object references.

Public Properties

Name Description
Public Property AllowedStreams Indicates which streams can be played.
Public Property Appearance Gets or sets a value determining the appearance of the control.
Public Property AudioProcessors Gets the registered audio processors collection object.
Public Property AudioRenderers Gets the registered audio renderers collection object.
Public Property Author Gets the name of the media's author (if it exists).
Public Property AutoRewind Gets a value indicating whether the object will automatically rewind to the starting point once playback has stopped.
Public Property AutoScrub Gets or sets a value indicating whether the object will automatically force a frame to the renderer while stopped.
Public Property AutoSize Gets or sets a value indicating whether the control will be automatically resized.
Public Property AutoStart Gets a value indicating whether the object will automatically start playing the media once the source has been assigned.
Public Property BackColor Gets or sets the background color for the control.
Public Property Balance Gets or sets the balance value of the audio stream.
Public Property BorderStyle Gets or sets the border style for the control.
Public Property ClosedCaptioning Gets a value that indicates whether closed captioning is enabled.
Public Property Copyright Gets copyright information for the (if it exists).
Public Property CurrentFramePosition Gets or sets the current frame position.
Public Property CurrentPosition Gets or sets the current position, relative to the total duration of the media, in seconds.
Public Property CurrentProgram Gets or sets the number of the current program for the media file.
Public Property CurrentTrackingPosition Gets or sets the current tracking position.
Public Property Description Gets the description of the media's content (if it exists).
Public Property Duration Gets the duration of the media, in seconds.
Public Property DvdController Gets the DVDControl object used to control DVD playback when a DVD is loaded.
Public Property DVDecoderResolution Gets or sets the current resolution for the DV Decoder.
Public Property Enabled Gets or sets a value indicating whether the control can respond to user interaction.
Public Property FrameDuration Gets the frame duration of the media, in seconds.
Public Property FullScreenMode Gets or sets the full-screen mode for the video renderer.
Public Property MidiRenderers Gets the registered midi renderers collection object.
Public Property Mute Gets a value indicating whether the audio is muted.
Public Property PlayCount Gets or sets the number of times that playback should repeat.
Public Property PreferredMPEG2Splitter Gets or sets the preferred MPEG2 splitter, by display name.
Public Property PreferredVideoRenderer Gets or sets the preferred VideoRendererType object.
Public Property ProgramCount Gets the number of programs.
Public Property Rate Gets or sets the rate of playback relative to normal playback speed.
Public Property Rating Gets the media's rating (if it exists).
Public Property RenderedStreams Gets the streams that have been rendered.
Public Property ScaleHeight Gets or sets the height of the client area of the control.
Public Property ScaleLeft Specifies the X coordinate of the origin in a custom coordinate system for the client area.
Public Property ScaleMode Specifies the unit of measure for the control.
Public Property ScaleTop Specifies the Y coordinate of the origin in a custom coordinate system for the client area.
Public Property ScaleWidth Specifies the width of the client area of the control.
Public Property SelectedAudioProcessors Gets or sets the selected audio processors collection object.
Public Property SelectedVideoProcessors Gets the selected video processors collection object.
Public Property SelectionEnd Gets or sets the current selection end position, in seconds.
Public Property SelectionStart Gets or sets the current selection start position, in seconds.
Public Property SourceAudioFOURCC Gets the FOURCC format id for the source audio.
Public Property SourceAudioType Gets a string that represents the GUID of the source's audio type.
Public Property SourceFile Gets or sets the media source filename, URL or UDP address.
Public Property SourceObject Gets or sets the media source object.
Public Property SourceStream Gets or sets the media source stream.
Public Property SourceType Gets the media source type.
Public Property SourceVideoFOURCC Gets the FOURCC format id of the source video format.
Public Property SourceVideoType Gets a string that represents the GUID of the source' video type.
Public Property State Gets the play control current state.
Public Property StillTap Gets or sets a value that indicates the point at which the still image will be captured.
Public Property Title Gets the media's title (if it exists).
Public Property TrackingSelectionEnd Gets the current tracking selection end position.
Public Property TrackingSelectionStart Gets the current tracking selection start position.
Public Property UnrenderedStreams Gets the streams that have not been rendered.
Public Property UseDVDSource Gets or sets a value that indicates whether the object will use the DVD Source object when attempting to convert a DVD image.
Public Property UsingDVDecoder Gets a value that indicates whether the state of the DV Decoder is in use.
Public Property VideoHeight Gets the height of the current video.
Public Property VideoProcessors Gets the registered video processors collection object.
Public Property VideoWidth Gets the width of the current video.
Public Property VideoWindow Gets the handle to the current video window.
Public Property VideoWindowHeight Gets the height of the video window.
Public Property VideoWindowLeft Gets the left position of the video window.
Public Property VideoWindowSizeMode Gets or sets the current video window size mode.
Public Property VideoWindowTop Gets the top position of the video window.
Public Property VideoWindowWidth Gets the width of the video window.
Public Property Volume Gets or sets the volume (amplitude) of the audio signal.
Public Property Window Gets the handle to the Play control window.
Public Property WMCertificate Gets or sets the user-assigned Windows Media Certificate.

Public Events

Name Description
Public Event Click Occurs when the control is clicked.
Public Event DoubleClick Occurs when the control is double-clicked.
Public Event ErrorAbort Occurs when an error has caused an operation to abort.
Public Event KeyDown Occurs when the control has detected a KeyDown event.
Public Event KeyPress Occurs when the control has detected a KeyPress event.
Public Event KeyUp Occurs when the control has detected a KeyUp event.
Public Event MediaEvent Occurs when the control has detected a media event.
Public Event MouseDown Occurs when the mouse pointer is over the control and a mouse button is pressed.
Public Event MouseEnter Occurs when the mouse pointer enters the control.
Public Event MouseHover Occurs when the mouse pointer rests on the control.
Public Event MouseLeave Occurs when the mouse pointer leaves the control.
Public Event MouseMove Occurs when the mouse pointer is moved over the control.
Public Event MouseUp Occurs when the mouse pointer is over the control and a mouse button is released.
Public Event Resize Occurs when the control is resized.
Public Event StateChanged Occurs when the object's state has changed.
Public Event TrackingPositionChanged Occurs periodically to provide notification of when the tracking position changes.
Public Event TrackingSelectionChanged Provides notification of tracking selection changes.

See Also

Reference

PlayCtrl Class

Leadtools.Multimedia Namespace

Help Version 21.0.2021.7.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Multimedia Assembly
Introduction
Getting Started
Namespaces
Leadtools.Multimedia Namespace
Leadtools.Multimedia.Common Namespace
Assemblies
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.