QuickTime Module Reference

New in version 0.0.6.

Control the macOS QuickTime application using JXA-like syntax.

Classes:

`XAQuickTimeApplication`(properties)	A class for managing and interacting with QuickTime.app.
`XAQuickTimeAudioCompressionPreset`(properties)	A class for managing and interacting with audio compression presets in QuickTime.app.
`XAQuickTimeAudioCompressionPresetList`(properties)	A wrapper around lists of audio compression presets that employs fast enumeration techniques.
`XAQuickTimeAudioRecordingDevice`(properties)	A class for managing and interacting with microphones in QuickTime.app.
`XAQuickTimeAudioRecordingDeviceList`(properties)	A wrapper around lists of audio recording devices that employs fast enumeration techniques.
`XAQuickTimeDocument`(properties)	A class for managing and interacting with documents in QuickTime.app.
`XAQuickTimeDocumentList`(properties[, filter])	A wrapper around lists of themes that employs fast enumeration techniques.
`XAQuickTimeMovieCompressionPreset`(properties)	A class for managing and interacting with movie compression presets in QuickTime.app.
`XAQuickTimeMovieCompressionPresetList`(properties)	A wrapper around lists of movie compression presets that employs fast enumeration techniques.
`XAQuickTimeScreenCompressionPreset`(properties)	A class for managing and interacting with screen compression presets in QuickTime.app.
`XAQuickTimeScreenCompressionPresetList`(...)	A wrapper around lists of screen compression presets that employs fast enumeration techniques.
`XAQuickTimeVideoRecordingDevice`(properties)	A class for managing and interacting with cameras in QuickTime.app.
`XAQuickTimeVideoRecordingDeviceList`(properties)	A wrapper around lists of video recording devices that employs fast enumeration techniques.
`XAQuickTimeWindow`(properties)	A QuickTime window.

class PyXA.apps.QuickTimePlayer.XAQuickTimeApplication(properties)[source]

Bases: XASBApplication, XACanOpenPath

A class for managing and interacting with QuickTime.app.

New in version 0.0.6.

Methods:

`audio_compression_presets`([filter])	Returns a list of audio compression presets, as PyXA objects, matching the given filter.
`audio_recording_devices`([filter])	Returns a list of audio recording devices, as PyXA objects, matching the given filter.
`documents`([filter])	Returns a list of documents, as PyXA objects, matching the given filter.
`movie_compression_presets`([filter])	Returns a list of movie compression presets, as PyXA objects, matching the given filter.
`new_audio_recording`()	Starts a new audio recording.
`new_movie_recording`()	Starts a new movie recording.
`new_screen_recording`()	Starts a new screen recording.
`open`(path)	Opens the file at the given filepath.
`open_url`(url)	Opens the file at the given (remote) URL.
`screen_compression_presets`([filter])	Returns a list of screen compression presets, as PyXA objects, matching the given filter.
`video_recording_devices`([filter])	Returns a list of video recording devices, as PyXA objects, matching the given filter.

Attributes:

`current_document`	The document currently open in the front window of QuickTime.
`frontmost`	Whether QuickTime is the frontmost application.
`name`	The name of the application.
`properties`	Every property of the QuickTime application.
`version`	The version of QuickTime.app.

audio_compression_presets(filter: dict | None = None) → XAQuickTimeAudioCompressionPresetList[source]

Returns a list of audio compression presets, as PyXA objects, matching the given filter.

Parameters:: filter (Union[dict, None]) – A dictionary specifying property-value pairs that all returned p[resets] will have, or None
Returns:: The list of audio compression presets
Return type:: XAQuickTimeAudioCompressionPresetList

New in version 0.0.6.

audio_recording_devices(filter: dict | None = None) → XAQuickTimeAudioRecordingDeviceList[source]

Returns a list of audio recording devices, as PyXA objects, matching the given filter.

Parameters:: filter (Union[dict, None]) – A dictionary specifying property-value pairs that all returned audio recording devices will have, or None
Returns:: The list of audio recording devices
Return type:: XAQuickTimeAudioRecordingDeviceList

New in version 0.0.6.

property current_document: XAQuickTimeDocument: The document currently open in the front window of QuickTime.

documents(filter: dict | None = None) → XAQuickTimeDocumentList[source]

Returns a list of documents, as PyXA objects, matching the given filter.

Parameters:: filter (Union[dict, None]) – A dictionary specifying property-value pairs that all returned documents will have, or None
Returns:: The list of documents
Return type:: XAQuickTimeDocumentList

New in version 0.0.6.

property frontmost: bool: Whether QuickTime is the frontmost application.

movie_compression_presets(filter: dict | None = None) → XAQuickTimeMovieCompressionPresetList[source]

Returns a list of movie compression presets, as PyXA objects, matching the given filter.

Parameters:: filter (Union[dict, None]) – A dictionary specifying property-value pairs that all returned presets will have, or None
Returns:: The list of movie compression presets
Return type:: XAQuickTimeMovieCompressionPresetList

New in version 0.0.6.

property name: str: The name of the application.

new_audio_recording() → XAQuickTimeDocument[source]

Starts a new audio recording.

Returns:: The newly created audio recording document.
Return type:: XAQuickTimeDocument

New in version 0.0.6.

new_movie_recording() → XAQuickTimeDocument[source]

Starts a new movie recording.

Returns:: The newly created movie recording document.
Return type:: XAQuickTimeDocument

New in version 0.0.6.

new_screen_recording() → XAQuickTimeApplication[source]

Starts a new screen recording.

Returns:: A reference to the application object.
Return type:: XAQuickTimeApplication

New in version 0.0.6.

open(path: str | NSURL) → XAQuickTimeDocument[source]

Opens the file at the given filepath.

Parameters:: target (Union[str, AppKit.NSURL]) – The path of a file to open.
Returns:: A reference to the newly opened document.
Return type:: XAQuickTimeDocument

New in version 0.0.6.

open_url(url: str | NSURL) → XAQuickTimeDocument[source]

Opens the file at the given (remote) URL.

Parameters:: target (Union[str, NSURL]) – The path of a file to stream.
Returns:: A reference to the newly opened document.
Return type:: XAQuickTimeDocument

New in version 0.0.6.

property properties: dict: Every property of the QuickTime application.

screen_compression_presets(filter: dict | None = None) → XAQuickTimeScreenCompressionPresetList[source]

Returns a list of screen compression presets, as PyXA objects, matching the given filter.

Parameters:: filter (Union[dict, None]) – A dictionary specifying property-value pairs that all returned presets will have, or None
Returns:: The list of screen compression presets
Return type:: XAQuickTimeScreenCompressionPresetList

New in version 0.0.6.

property version: str: The version of QuickTime.app.

video_recording_devices(filter: dict | None = None) → XAQuickTimeVideoRecordingDeviceList[source]

Returns a list of video recording devices, as PyXA objects, matching the given filter.

Parameters:: filter (Union[dict, None]) – A dictionary specifying property-value pairs that all returned video recording devices will have, or None
Returns:: The list of video recording devices
Return type:: XAQuickTimeVideoRecordingDeviceList

New in version 0.0.6.

class PyXA.apps.QuickTimePlayer.XAQuickTimeAudioCompressionPreset(properties)[source]

Bases: XAObject

A class for managing and interacting with audio compression presets in QuickTime.app.

See also

XAQuickTimeApplication

New in version 0.0.6.

Attributes:

`id`	The unique identifier for the preset.
`name`	The name of the preset.
`properties`	All properties of the preset.

property id: str: The unique identifier for the preset.

property name: str: The name of the preset.

property properties: dict: All properties of the preset.

class PyXA.apps.QuickTimePlayer.XAQuickTimeAudioCompressionPresetList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of audio compression presets that employs fast enumeration techniques.

All properties of audio compression presets can be called as methods on the wrapped list, returning a list containing each presets’s value for the property.

New in version 0.0.6.

Methods:

`id`()
`name`()
`properties`()

id() → list[str][source]

name() → list[str][source]

properties() → list[dict][source]

class PyXA.apps.QuickTimePlayer.XAQuickTimeAudioRecordingDevice(properties)[source]

Bases: XAObject

A class for managing and interacting with microphones in QuickTime.app.

See also

XAQuickTimeApplication

New in version 0.0.6.

Attributes:

`id`	The unique identifier for the device.
`name`	The name of the device.
`properties`	All properties of the device.

property id: str: The unique identifier for the device.

property name: str: The name of the device.

property properties: dict: All properties of the device.

class PyXA.apps.QuickTimePlayer.XAQuickTimeAudioRecordingDeviceList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of audio recording devices that employs fast enumeration techniques.

All properties of audio recording devices can be called as methods on the wrapped list, returning a list containing each devices’s value for the property.

New in version 0.0.6.

Methods:

`id`()
`name`()
`properties`()

id() → list[str][source]

name() → list[str][source]

properties() → list[dict][source]

class PyXA.apps.QuickTimePlayer.XAQuickTimeDocument(properties)[source]

Bases: XAObject

A class for managing and interacting with documents in QuickTime.app.

See also

XAQuickTimeApplication

New in version 0.0.6.

Attributes:

`audio_volume`	The volume of the movie from 0 to 1 (0 to 100%).
`current_audio_compression`	The current audio compression preset.
`current_camera`	The currently previewing video device.
`current_microphone`	The currently previewing audio device.
`current_movie_compression`	The current movie compression preset.
`current_screen_compression`	The current screen compression preset.
`current_time`	The current time of the movie in seconds.
`data_rate`	The data rate of the movie in bytes per second.
`data_size`	The data size of the movie in bytes.
`duration`	The duration of the movie in seconds.
`looping`	Whether the movie plays in a loop.
`muted`	Whether the movie is muted.
`natural_dimensions`	The national dimensions of the movie.
`playing`	Whether the movie is currently playing.
`presenting`	Whether the movie is presented in full screen.
`properties`	All properties of the document.
`rate`	The current rate of the movie.

Methods:

`pause`()
`play`()
`present`()
`resume`()
`start`()
`step_backward`(num_steps)
`step_forward`(num_steps)
`stop`()
`trim`(start_time, end_time)

property audio_volume: float: The volume of the movie from 0 to 1 (0 to 100%).

property current_audio_compression: XAQuickTimeAudioCompressionPreset: The current audio compression preset.

property current_camera: XAQuickTimeVideoRecordingDevice: The currently previewing video device.

property current_microphone: XAQuickTimeAudioRecordingDevice: The currently previewing audio device.

property current_movie_compression: XAQuickTimeMovieCompressionPreset: The current movie compression preset.

property current_screen_compression: XAQuickTimeScreenCompressionPreset: The current screen compression preset.

property current_time: float: The current time of the movie in seconds.

property data_rate: int: The data rate of the movie in bytes per second.

property data_size: int: The data size of the movie in bytes.

property duration: float: The duration of the movie in seconds.

property looping: bool: Whether the movie plays in a loop.

property muted: bool: Whether the movie is muted.

property natural_dimensions: tuple[int, int]: The national dimensions of the movie.

pause() → XAQuickTimeDocument[source]

play() → XAQuickTimeDocument[source]

property playing: bool: Whether the movie is currently playing.

present() → XAQuickTimeDocument[source]

property presenting: bool: Whether the movie is presented in full screen.

property properties: dict: All properties of the document.

property rate: float: The current rate of the movie.

resume() → XAQuickTimeDocument[source]

start() → XAQuickTimeDocument[source]

step_backward(num_steps: int) → XAQuickTimeDocument[source]

step_forward(num_steps: int) → XAQuickTimeDocument[source]

stop() → XAQuickTimeDocument[source]

trim(start_time: float, end_time: float) → XAQuickTimeDocument[source]

class PyXA.apps.QuickTimePlayer.XAQuickTimeDocumentList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of themes that employs fast enumeration techniques.

All properties of themes can be called as methods on the wrapped list, returning a list containing each theme’s value for the property.

New in version 0.0.6.

Methods:

`audio_volume`()
`by_audio_volume`(audio_volume)
`by_current_audio_compression`(...)
`by_current_camera`(current_camera)
`by_current_microphone`(current_microphone)
`by_current_movie_compression`(...)
`by_current_screen_compression`(...)
`by_current_time`(current_time)
`by_data_rate`(data_rate)
`by_data_size`(data_size)
`by_duration`(duration)
`by_looping`(looping)
`by_muted`(muted)
`by_natural_dimensions`(natural_dimensions)
`by_playing`(playing)
`by_presenting`(presenting)
`by_properties`(properties)
`by_rate`(rate)
`current_audio_compression`()
`current_camera`()
`current_microphone`()
`current_movie_compression`()
`current_screen_compression`()
`current_time`()
`data_rate`()
`data_size`()
`duration`()
`looping`()
`muted`()
`natural_dimensions`()
`playing`()
`presenting`()
`properties`()
`rate`()

audio_volume() → list[float][source]

by_audio_volume(audio_volume: float) → XAQuickTimeDocument[source]

by_current_audio_compression(current_audio_compression: float) → XAQuickTimeDocument[source]

by_current_camera(current_camera: float) → XAQuickTimeDocument[source]

by_current_microphone(current_microphone: float) → XAQuickTimeDocument[source]

by_current_movie_compression(current_movie_compression: float) → XAQuickTimeDocument[source]

by_current_screen_compression(current_screen_compression: float) → XAQuickTimeDocument[source]

by_current_time(current_time: float) → XAQuickTimeDocument[source]

by_data_rate(data_rate: int) → XAQuickTimeDocument[source]

by_data_size(data_size: int) → XAQuickTimeDocument[source]

by_duration(duration: float) → XAQuickTimeDocument[source]

by_looping(looping: bool) → XAQuickTimeDocument[source]

by_muted(muted: bool) → XAQuickTimeDocument[source]

by_natural_dimensions(natural_dimensions: tuple[int, int]) → XAQuickTimeDocument[source]

by_playing(playing: bool) → XAQuickTimeDocument[source]

by_presenting(presenting: bool) → XAQuickTimeDocument[source]

by_properties(properties: dict) → XAQuickTimeDocument[source]

by_rate(rate: float) → XAQuickTimeDocument[source]

current_audio_compression() → XAQuickTimeAudioCompressionPresetList[source]

current_camera() → XAQuickTimeVideoRecordingDeviceList[source]

current_microphone() → XAQuickTimeAudioRecordingDeviceList[source]

current_movie_compression() → XAQuickTimeMovieCompressionPresetList[source]

current_screen_compression() → XAQuickTimeScreenCompressionPresetList[source]

current_time() → list[float][source]

data_rate() → list[int][source]

data_size() → list[int][source]

duration() → list[float][source]

looping() → list[bool][source]

muted() → list[bool][source]

natural_dimensions() → list[tuple[int, int]][source]

playing() → list[bool][source]

presenting() → list[bool][source]

properties() → list[dict][source]

rate() → list[float][source]

class PyXA.apps.QuickTimePlayer.XAQuickTimeMovieCompressionPreset(properties)[source]

Bases: XAObject

A class for managing and interacting with movie compression presets in QuickTime.app.

See also

XAQuickTimeApplication

New in version 0.0.6.

Attributes:

`id`	The unique identifier for the preset.
`name`	The name of the preset.
`properties`	All properties of the preset.

property id: str: The unique identifier for the preset.

property name: str: The name of the preset.

property properties: dict: All properties of the preset.

class PyXA.apps.QuickTimePlayer.XAQuickTimeMovieCompressionPresetList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of movie compression presets that employs fast enumeration techniques.

All properties of movie compression presets can be called as methods on the wrapped list, returning a list containing each presets’s value for the property.

New in version 0.0.6.

Methods:

`id`()
`name`()
`properties`()

id() → list[str][source]

name() → list[str][source]

properties() → list[dict][source]

class PyXA.apps.QuickTimePlayer.XAQuickTimeScreenCompressionPreset(properties)[source]

Bases: XAObject

A class for managing and interacting with screen compression presets in QuickTime.app.

See also

XAQuickTimeApplication

New in version 0.0.6.

Attributes:

`id`	The unique identifier for the preset.
`name`	The name of the preset.
`properties`	All properties of the preset.

property id: str: The unique identifier for the preset.

property name: str: The name of the preset.

property properties: dict: All properties of the preset.

class PyXA.apps.QuickTimePlayer.XAQuickTimeScreenCompressionPresetList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of screen compression presets that employs fast enumeration techniques.

All properties of screen compression presets can be called as methods on the wrapped list, returning a list containing each presets’s value for the property.

New in version 0.0.6.

Methods:

`id`()
`name`()
`properties`()

id() → list[str][source]

name() → list[str][source]

properties() → list[dict][source]

class PyXA.apps.QuickTimePlayer.XAQuickTimeVideoRecordingDevice(properties)[source]

Bases: XAObject

A class for managing and interacting with cameras in QuickTime.app.

See also

XAQuickTimeApplication

New in version 0.0.6.

Attributes:

`id`	The unique identifier for the device.
`name`	The name of the device.
`properties`	All properties of the device.

property id: str: The unique identifier for the device.

property name: str: The name of the device.

property properties: dict: All properties of the device.

class PyXA.apps.QuickTimePlayer.XAQuickTimeVideoRecordingDeviceList(properties: dict, filter: dict | None = None)[source]

Bases: XAList

A wrapper around lists of video recording devices that employs fast enumeration techniques.

All properties of video recording devices can be called as methods on the wrapped list, returning a list containing each devices’s value for the property.

New in version 0.0.6.

Methods:

`id`()
`name`()
`properties`()

id() → list[str][source]

name() → list[str][source]

properties() → list[dict][source]

class PyXA.apps.QuickTimePlayer.XAQuickTimeWindow(properties)[source]

Bases: XASBWindow

A QuickTime window.

See also

XAQuickTimeApplication

New in version 0.0.6.

Attributes:

`document`	The document currently displayed in the front window of QuickTime.
`properties`	Every property of a QuickTime window.

property document: XAQuickTimeDocument: The document currently displayed in the front window of QuickTime.

property properties: dict: Every property of a QuickTime window.