DicomObjects.NetStandard Documentation
DicomObjects.Video Namespace / VideoCompressionOptions Class / VideoCompressionOptions Constructor
The Image to be compressed to video
The output format - see remarks
If specified (may be null), then the specific codec is used - otherwise this can be selected internally based on the container
If set to a value convertable to an integer, then this is used to initialise the BitsPerSecond property



In This Topic
    VideoCompressionOptions Constructor
    In This Topic
    Construct a default set of compression options for a given image and output format
    Syntax
    'Declaration
     
    
    Public Function New( _
       ByVal Image As DicomDataSet, _
       ByVal Format As String, _
       ByVal Codec As String, _
       ByVal Quality As Object _
    )
    'Usage
     
    
    Dim Image As DicomDataSet
    Dim Format As String
    Dim Codec As String
    Dim Quality As Object
     
    Dim instance As New VideoCompressionOptions(Image, Format, Codec, Quality)
    public VideoCompressionOptions( 
       DicomDataSet Image,
       string Format,
       string Codec,
       object Quality
    )
    public:
    VideoCompressionOptions( 
       DicomDataSet^ Image,
       String^ Format,
       String^ Codec,
       Object^ Quality
    )

    Parameters

    Image
    The Image to be compressed to video
    Format
    The output format - see remarks
    Codec
    If specified (may be null), then the specific codec is used - otherwise this can be selected internally based on the container
    Quality
    If set to a value convertable to an integer, then this is used to initialise the BitsPerSecond property
    Remarks

    This constructor sets very many default options, depending on the characteristics of the image and the output format. Only change them if you know what you are doing!

    The format parameter has 2 quite different forms:

    • If it is a UID, then it is interpretted as a DICOM Transfer Syntax, and options are set according to the DICOM rules for that transfer syntax
    • Otherwise, it is treated as an container format (such as "avi" or "mp4")

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also