MKVAttachment¶

MKVAttachment classes are used to represent attachment files within an MKV or to be used in an MKV.

Examples

Below are some basic examples of how the MKVAttachment objects can be used.

Create a new MKVAttachment and add it to an MKVFile.

>>> from pymkv import MKVAttachment
>>> attachment = MKVAttachment('path/to/attachment.jpg', name='NAME')
>>> attachment.description = 'DESCRIPTION'

Attachments can also be added directly to an MKVFile.

>>> from pymkv import MKVFile
>>> mkv = MKVFile('path/to/file.mkv')
>>> mkv.add_attachment('path/to/other/attachment.png')

Now, the MKV can be muxed with both attachments.

>>> mkv.add_attachment(attachment)
>>> mkv.mux('path/to/output.mkv')

class pymkv.MKVAttachment(file_path: str, name: str | None = None, description: str | None = None, attach_once: bool | None = False)¶

A class that represents an MKV attachment for an MKVFile object.

Parameters:

file_path (str) – The path to the attachment file.
name (str, optional) – The name that will be given to the attachment when muxed into a file.
description (str, optional) – The description that will be given to the attachment when muxed into a file.
attach_once (bool, optional) – Determines if the attachment should be added to all split files or only the first. Default is False, which will attach to all files.

mime_type¶

The attachment’s MIME type. The type will be guessed when file_path is set.

name¶

The name that will be given to the attachment when muxed into a file.

description¶

The description that will be given to the attachment when muxed into a file.

attach_once¶

Determines if the attachment should be added to all split files or only the first. Default is False, which will attach to all files.

property file_path: str¶

The path to the attachment file.