# cmd module

Command module.

Used to run main commands and get arguments and set the display, image, compare, LUT options.

mrv2.cmd.args() → list[str]

  Get command-line arguments passed as single quoted string to -pythonArgs.

mrv2.cmd.close(item: int = -1) → None

  Close the file item.

mrv2.cmd.closeAll() → None

  Close all file items.

mrv2.cmd.compare(itemA: int, itemB: int, mode: mrv2.media.CompareMode = <CompareMode.Wipe: 2>) → None

  Compare two file items with a compare mode.

mrv2.cmd.compareOptions() → mrv2.media.CompareOptions

  Return the current compare options.

mrv2.cmd.displayOptions() → mrv2.image.DisplayOptions

  Return the display options.

mrv2.cmd.environmentMapOptions() → mrv2.image.EnvironmentMapOptions

  Return the environment map options.

mrv2.cmd.getBackend() → str

  Get the backend of mrv2.

mrv2.cmd.getLanguage() → str

  Get the language of mrv2.

mrv2.cmd.getLayers() → list[str]

  Get the layers of the timeline (GUI).

mrv2.cmd.getVersion() → str

  Get the version of mrv2.

mrv2.cmd.imageOptions() → mrv2.image.ImageOptions

  Return the image options.

mrv2.cmd.isMuted() → bool

  Returns true if audio is muted.

mrv2.cmd.lutOptions() → mrv2.image.LUTOptions

  Return the LUT options.

mrv2.cmd.open(fileName: str, audioFileName: str = '') → None

  Open file with optional audio.

mrv2.cmd.prefsPath() → str

  Return the path to preferences of mrv2.

mrv2.cmd.rootPath() → str

  Return the root path to the installation of mrv2.

mrv2.cmd.run(arg0: str, arg1: str) → None

  Runs the same or a new mrv2 with a session file.

mrv2.cmd.save(fileName: str, options: mrv2.io.SaveOptions = <mrv2.io.SaveOptions annotations=False video=True saveVideo=True ffmpegProfile=None ffmpegPreset= ffmpegPixelFormat=YUV420P ffmpegAudioCodec=AAC ffmpegHardwareEncode=False ffmpegOverride=False ffmpegColorRange= ffmpegColorSpace= ffmpegColorPrimaries= ffmpegColorTRC= exrCompression=zip exrPixelType=RGBA_F16 zipCompressionLevel=4 dwaCompressionLevel=45>) → None

  Save a movie or sequence from the front layer.

mrv2.cmd.saveMultipleAnnotationFrames(fileName: str, times: list[mrv2.RationalTime] = [], options: mrv2.io.SaveOptions = <mrv2.io.SaveOptions annotations=False video=True saveVideo=True ffmpegProfile=None ffmpegPreset= ffmpegPixelFormat=YUV420P ffmpegAudioCodec=AAC ffmpegHardwareEncode=False ffmpegOverride=False ffmpegColorRange= ffmpegColorSpace= ffmpegColorPrimaries= ffmpegColorTRC= exrCompression=zip exrPixelType=RGBA_F16 zipCompressionLevel=4 dwaCompressionLevel=45>) → None

  Save multiple annotation frames.

mrv2.cmd.saveMultipleFrames(fileName: str, times: list[mrv2.RationalTime] = [], options: mrv2.io.SaveOptions = <mrv2.io.SaveOptions annotations=False video=True saveVideo=True ffmpegProfile=None ffmpegPreset= ffmpegPixelFormat=YUV420P ffmpegAudioCodec=AAC ffmpegHardwareEncode=False ffmpegOverride=False ffmpegColorRange= ffmpegColorSpace= ffmpegColorPrimaries= ffmpegColorTRC= exrCompression=zip exrPixelType=RGBA_F16 zipCompressionLevel=4 dwaCompressionLevel=45>) → None

  Save multiple frames.

mrv2.cmd.saveOTIO(fileName: str) → None

  Save an .otio file from the current selected image.

mrv2.cmd.savePDF(fileName: str) → bool

  Save a PDF document with all annotations and notes.

mrv2.cmd.saveSingleFrame(fileName: str, options: mrv2.io.SaveOptions = <mrv2.io.SaveOptions annotations=False video=True saveVideo=True ffmpegProfile=None ffmpegPreset= ffmpegPixelFormat=YUV420P ffmpegAudioCodec=AAC ffmpegHardwareEncode=False ffmpegOverride=False ffmpegColorRange= ffmpegColorSpace= ffmpegColorPrimaries= ffmpegColorTRC= exrCompression=zip exrPixelType=RGBA_F16 zipCompressionLevel=4 dwaCompressionLevel=45>) → None

  Save a single frame.

mrv2.cmd.setCompareOptions(options: mrv2.media.CompareOptions) → None

  Set the compare options.

mrv2.cmd.setDisplayOptions(options: mrv2.image.DisplayOptions) → None

  Set the display options.

mrv2.cmd.setEnvironmentMapOptions(options: mrv2.image.EnvironmentMapOptions) → None

  Set the environment map options.

mrv2.cmd.setImageOptions(options: mrv2.image.ImageOptions) → None

  Set the image options.

mrv2.cmd.setLUTOptions(options: mrv2.image.LUTOptions) → None

  Set the LUT options.

mrv2.cmd.setMute(mute: float) → None

  Set the muting of the audio.

mrv2.cmd.setStereo3DOptions(options: mrv2.image.Stereo3DOptions) → None

  Set the stereo 3D options.

mrv2.cmd.setVolume(volume: float) → None

  Set the playback volume.

mrv2.cmd.stereo3DOptions() → mrv2.image.Stereo3DOptions

  Return the current stereo 3D options.

mrv2.cmd.toggleAutoNormalize() → None

  Toggle Image Auto Normalize.

mrv2.cmd.toggleDataWindow() → None

  Toggle Data Window.

mrv2.cmd.toggleDisplayWindow() → None

  Toggle Display Window.

mrv2.cmd.toggleIgnoreDisplayWindow() → None

  Toggle Ignored Display Window on OpenEXRs.

mrv2.cmd.toggleInvalidValues() → None

  Toggle Image invalid values.

mrv2.cmd.toggleSafeAreas() → None

  Toggle Safe Areas.

mrv2.cmd.update() → float

  Call Fl::check to update the GUI and return the number of seconds that elapsed.

mrv2.cmd.volume() → float

  Get the playback volume.