ParoleFile

ParoleFile

Functions

Properties

gchar * content-type Read
gchar * custom-subtitles Read / Write / Construct Only
gchar * directory Read / Write / Construct Only
gchar * display-name Read / Write / Construct Only
gint dvd-chapter Read / Write / Construct Only
gchar * filename Read / Write / Construct Only
gchar * uri Read

Types and Values

struct ParoleFile

Object Hierarchy

    GObject
    ╰── ParoleFile

Description

Functions

parole_file_new ()

ParoleFile *
parole_file_new (const gchar *filename);

Create a new ParoleFile.

Parameters

filename

filename

 

Returns

A new ParoleFile object

Since: 0.2


parole_file_new_with_display_name ()

ParoleFile *
parole_file_new_with_display_name (const gchar *filename,
                                   const gchar *display_name);

Create a new ParoleFile for a file stored on the filesystem.

Parameters

filename

filename

 

display_name

the name to display

 

Returns

A new ParoleFile object

Since: 0.2


parole_file_new_cdda_track ()

ParoleFile *
parole_file_new_cdda_track (const gint track_num,
                            const gchar *display_name);

Create a new ParoleFile object for a CD track number.

Parameters

track_num

cd track number

 

display_name

the track name to display

 

Returns

A new ParoleFile object

Since: 0.4


parole_file_new_dvd_chapter ()

ParoleFile *
parole_file_new_dvd_chapter (gint chapter_num,
                             const gchar *display_name);

Create a new ParoleFile object for a DVD chapter number.

Parameters

chapter_num

dvd chapter number

 

display_name

the chapter name to display

 

Returns

A new ParoleFile object

Since: 0.4


parole_file_set_dvd_chapter ()

void
parole_file_set_dvd_chapter (const ParoleFile *file,
                             gint dvd_chapter);

Set the chapter number for a ParoleFile.

Parameters

file

a ParoleFile

 

dvd_chapter

chapter number to store

 

Since: 0.4


parole_file_get_dvd_chapter ()

gint
parole_file_get_dvd_chapter (const ParoleFile *file);

Get the chapter number for a ParoleFile.

Parameters

file

a ParoleFile

 

Returns

An int containing the dvd chapter number

Since: 0.4


parole_file_set_custom_subtitles ()

void
parole_file_set_custom_subtitles (const ParoleFile *file,
                                  gchar *suburi);

Set the custom subtitles path for a ParoleFile.

Parameters

file

a ParoleFile

 

suburi

uri for the subtitles file

 

Since: 0.4

Types and Values

struct ParoleFile

struct ParoleFile;

File instance used by Parole.

Since: 0.2

Property Details

The “content-type” property

  “content-type”             gchar *

The content type of the file.

Owner: ParoleFile

Flags: Read

Default value: NULL

Since: 0.2


The “custom-subtitles” property

  “custom-subtitles”         gchar *

The custom subtitles set by the user.

Owner: ParoleFile

Flags: Read / Write / Construct Only

Default value: NULL


The “directory” property

  “directory”                gchar *

The parent directory of the file.

Owner: ParoleFile

Flags: Read / Write / Construct Only

Default value: NULL

Since: 0.2


The “display-name” property

  “display-name”             gchar *

A UTF-8 name that can be displayed in the UI.

Owner: ParoleFile

Flags: Read / Write / Construct Only

Default value: NULL

Since: 0.2


The “dvd-chapter” property

  “dvd-chapter”              gint

DVD Chapter, used for seeking a DVD using the playlist.

Owner: ParoleFile

Flags: Read / Write / Construct Only

Allowed values: [-1,1000]

Default value: -1


The “filename” property

  “filename”                 gchar *

The file name of the file.

Owner: ParoleFile

Flags: Read / Write / Construct Only

Default value: NULL

Since: 0.2


The “uri” property

  “uri”                      gchar *

The uri of the file.

Owner: ParoleFile

Flags: Read

Default value: NULL

Since: 0.2