InterDVDDisc

Inherits: Node < Object

Scene-tree root for an Interactive DVD. Compiles to InterDVDProject at export.

Description

Author titles, menus, and encode settings on this node instead of ProjectSettings. Child InterDVDTitle and InterDVDTitleSet nodes become VTS titles. Child InterDVDMenuPage nodes become VMGM/VTSM menus. build_project() is the export IR. Project → Tools → Create Interactive DVD Scene inserts a VLC-safe skeleton (title menu, main title, menu title).

Properties

int	ac3_bitrate_k	`192`
int	ac3_channels	`2`
String	audio_language	`"en"`
String	author	`""`
String	autorun_icon	`""`
String	autorun_label	`""`
String	autorun_open	`""`
int	bake_warmup_frames	`2`
String	copyright	`""`
String	copyright_file	`""`
String	credits	`""`
String	credits_file	`""`
String	disc_title	`""`
PackedStringArray	extras	`PackedStringArray()`
String	extras_dir	`""`
FirstPlay	first_play	`0`
NodePath	first_play_path	`NodePath("")`
int	gop_size	`15`
String	license	`""`
String	license_file	`""`
String	menu_language	`"en"`
int	parental_level	`1`
float	pip_blackdetect_sec	`2.5`
float	pip_blackdetect_pix_th	`0.12`
String	provider_id	`"BLAZIUM INTER-DVD"`
String	publisher	`""`
String	readme	`""`
String	readme_file	`""`
int	region_mask	`1`
String	serial	`""`
String	studio	`""`
String	subtitle_language	`"en"`
int	title_safe_bottom	`432`
String	version	`""`
String	volume_id	`"BLAZIUM_DVD"`
String	website	`""`

Methods

InterDVDChapter	add_chapter_to_last(name: String = "Chapter")
InterDVDTitle	add_menu_title(name: String = "Menu")
InterDVDTitle	add_title(name: String = "Title")
InterDVDMenuPage	add_title_menu(name: String = "TitleMenu")
InterDVDMenuPage	add_root_menu(name: String = "RootMenu")
InterDVDTitleSet	add_title_set(name: String = "TitleSet")
void	apply_settings_to(project: InterDVDProject)
void	apply_scene_owner(owner: Node)
InterDVDProject	build_project() const
InterDVDDisc	create_starter() static
InterDVDDisc	find_in_tree(root: Node) static

Enumerations

enum FirstPlay: 🔗

FirstPlay FIRST_PLAY_TITLE_MENU = 0

Boot the VMGM title menu when it has buttons; otherwise JumpTT to the main title.

FirstPlay FIRST_PLAY_MAIN_TITLE = 1

First Play JumpTT to the first title that is not a menu title.

FirstPlay FIRST_PLAY_PATH = 2

First Play JumpTT to first_play_path.

Property Descriptions

int ac3_bitrate_k = 192 🔗

void set_ac3_bitrate_k(value: int)
int get_ac3_bitrate_k()

AC3 encode bitrate in kbps.

int ac3_channels = 2 🔗

void set_ac3_channels(value: int)
int get_ac3_channels()

AC3 channel count (1–6).

String audio_language = "en" 🔗

void set_audio_language(value: String)
String get_audio_language()

Default title audio language.

String author = "" 🔗

void set_author(value: String)
String get_author()

Disc metadata author.

String autorun_icon = "" 🔗

void set_autorun_icon(value: String)
String get_autorun_icon()

Optional AUTORUN.INF icon path.

String autorun_label = "" 🔗

void set_autorun_label(value: String)
String get_autorun_label()

Optional AUTORUN.INF label.

String autorun_open = "" 🔗

void set_autorun_open(value: String)
String get_autorun_open()

Optional AUTORUN.INF open target.

int bake_warmup_frames = 2 🔗

void set_bake_warmup_frames(value: int)
int get_bake_warmup_frames()

Viewport frames skipped before the first captured bake frame.

String copyright = "" 🔗

void set_copyright(value: String)
String get_copyright()

Copyright text packed by the toolchain.

String copyright_file = "" 🔗

void set_copyright_file(value: String)
String get_copyright_file()

Copyright file copied onto the disc root.

String credits = "" 🔗

void set_credits(value: String)
String get_credits()

Credits text packed by the toolchain.

String credits_file = "" 🔗

void set_credits_file(value: String)
String get_credits_file()

Credits file copied onto the disc root.

String disc_title = "" 🔗

void set_disc_title(value: String)
String get_disc_title()

Human title written into TXTDT_MGI.

PackedStringArray extras = PackedStringArray() 🔗

void set_extras(value: PackedStringArray)
PackedStringArray get_extras()

Host paths to pack beside VIDEO_TS.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedStringArray for more details.

String extras_dir = "" 🔗

void set_extras_dir(value: String)
String get_extras_dir()

Host folder merged onto the disc root.

FirstPlay first_play = 0 🔗

void set_first_play(value: FirstPlay)
FirstPlay get_first_play()

Boot command: title menu, main title, or first_play_path.

NodePath first_play_path = NodePath("") 🔗

void set_first_play_path(value: NodePath)
NodePath get_first_play_path()

Title to JumpTT when first_play is FIRST_PLAY_PATH.

int gop_size = 15 🔗

void set_gop_size(value: int)
int get_gop_size()

MPEG GOP size passed to ffmpeg -g.

String license = "" 🔗

void set_license(value: String)
String get_license()

License text packed by the toolchain.

String license_file = "" 🔗

void set_license_file(value: String)
String get_license_file()

License file copied onto the disc root.

String menu_language = "en" 🔗

void set_menu_language(value: String)
String get_menu_language()

ISO 639-1 code on VMGM/VTSM language units.

int parental_level = 1 🔗

void set_parental_level(value: int)
int get_parental_level()

Parental level stored in disc metadata.

float pip_blackdetect_sec = 2.5 🔗

void set_pip_blackdetect_sec(value: float)
float get_pip_blackdetect_sec()

Seconds scanned for PiP lead-in black.

float pip_blackdetect_pix_th = 0.12 🔗

void set_pip_blackdetect_pix_th(value: float)
float get_pip_blackdetect_pix_th()

PiP black-detect pixel threshold.

String provider_id = "BLAZIUM INTER-DVD" 🔗

void set_provider_id(value: String)
String get_provider_id()

32-byte VMGI provider identifier.

String publisher = "" 🔗

void set_publisher(value: String)
String get_publisher()

ISO9660 publisher identifier.

String readme = "" 🔗

void set_readme(value: String)
String get_readme()

Readme text packed by the toolchain.

String readme_file = "" 🔗

void set_readme_file(value: String)
String get_readme_file()

Readme file copied onto the disc root.

int region_mask = 1 🔗

void set_region_mask(value: int)
int get_region_mask()

Region mask written into the VMG.

String serial = "" 🔗

void set_serial(value: String)
String get_serial()

Optional disc serial (max 15 characters).

String studio = "" 🔗

void set_studio(value: String)
String get_studio()

Studio name in disc metadata.

String subtitle_language = "en" 🔗

void set_subtitle_language(value: String)
String get_subtitle_language()

Default subtitle language.

int title_safe_bottom = 432 🔗

void set_title_safe_bottom(value: int)
int get_title_safe_bottom()

NTSC title-safe bottom scanline for HLI clamp.

String version = "" 🔗

void set_version(value: String)
String get_version()

Disc version string.

String volume_id = "BLAZIUM_DVD" 🔗

void set_volume_id(value: String)
String get_volume_id()

ISO9660 volume label.

String website = "" 🔗

void set_website(value: String)
String get_website()

Studio or product website.

Method Descriptions

InterDVDChapter add_chapter_to_last(name: String = "Chapter") 🔗

Appends a chapter to the last title, creating a title if needed.

Appends a VLC-safe menu title PGC (InterDVDTitle.menu_title, still 255).

InterDVDTitle add_title(name: String = "Title") 🔗

Appends a title child and returns it.

Appends a VMGM title menu with still time 0.

Appends a VTSM root menu on the last title set, or as a disc child.

InterDVDTitleSet add_title_set(name: String = "TitleSet") 🔗

Appends an InterDVDTitleSet (one VTS_NN).

void apply_settings_to(project: InterDVDProject) 🔗

Copies disc identity, encode, extras, and languages onto project. Used by build_project().

void apply_scene_owner(owner: Node) 🔗

Sets owner on this node (if it is not the owner) and every descendant so the scene tree saves children.

InterDVDProject build_project() const 🔗

Walks children and returns the authored disc graph. Resolves hotspot InterDVDHotspot.destination paths to title numbers. FIRST_PLAY_TITLE_MENU leaves First Play empty when a title menu has buttons (export JumpSS). FIRST_PLAY_MAIN_TITLE writes JumpTT to the first non-menu title.

InterDVDDisc create_starter() static 🔗

Builds Disc / TitleMenu+Play / Main+Chapter1 / Menu+Play with Play jumping to Main.

InterDVDDisc find_in_tree(root: Node) static 🔗

Returns root if it is an InterDVDDisc, otherwise the first descendant disc, or null.