ParoleFile

ParoleFile

Synopsis

struct              ParoleFile;
struct              ParoleFileClass;
const gchar const   * parole_file_get_content_type      (const ParoleFile *file);
const gchar const   * parole_file_get_custom_subtitles  (const ParoleFile *file);
const gchar const   * parole_file_get_directory         (const ParoleFile *file);
const gchar const   * parole_file_get_display_name      (const ParoleFile *file);
gint                parole_file_get_dvd_chapter         (const ParoleFile *file);
const gchar const   * parole_file_get_file_name         (const ParoleFile *file);
const gchar const   * parole_file_get_uri               (const ParoleFile *file);
ParoleFile *        parole_file_new                     (const gchar *filename);
ParoleFile *        parole_file_new_cdda_track          (const gint track_num,
                                                         const gchar *display_name);
ParoleFile *        parole_file_new_dvd_chapter         (gint chapter_num,
                                                         const gchar *display_name);
ParoleFile *        parole_file_new_with_display_name   (const gchar *filename,
                                                         const gchar *display_name);
void                parole_file_set_custom_subtitles    (const ParoleFile *file,
                                                         gchar *suburi);
void                parole_file_set_dvd_chapter         (const ParoleFile *file,
                                                         gint dvd_chapter);

Object Hierarchy

  GObject
   +----ParoleFile

Properties

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

Description

Details

struct ParoleFile

struct ParoleFile;


struct ParoleFileClass

struct ParoleFileClass {
    GObjectClass 		parent_class;
};


parole_file_get_content_type ()

const gchar const   * parole_file_get_content_type      (const ParoleFile *file);

file :

a ParoleFile.

Returns :

A string containing the content type of the file.

Since 0.2


parole_file_get_custom_subtitles ()

const gchar const   * parole_file_get_custom_subtitles  (const ParoleFile *file);

file :

a ParoleFile.

Returns :

A string containing the custom subtitles file path.

Since 0.4


parole_file_get_directory ()

const gchar const   * parole_file_get_directory         (const ParoleFile *file);

file :

a ParoleFile.

Returns :

A string containing the parent directory path.

Since 0.2


parole_file_get_display_name ()

const gchar const   * parole_file_get_display_name      (const ParoleFile *file);

file :

a ParoleFile.

Returns :

A string containing the display name.

Since 0.2


parole_file_get_dvd_chapter ()

gint                parole_file_get_dvd_chapter         (const ParoleFile *file);

file :

a ParoleFile.

Returns :

An int containing the dvd chapter number.

Since 0.4


parole_file_get_file_name ()

const gchar const   * parole_file_get_file_name         (const ParoleFile *file);

file :

a ParoleFile.

Returns :

A string containing the file name.

Since 0.2


parole_file_get_uri ()

const gchar const   * parole_file_get_uri               (const ParoleFile *file);

file :

a ParoleFile.

Returns :

A string containing the file uri.

Since 0.2


parole_file_new ()

ParoleFile *        parole_file_new                     (const gchar *filename);

filename :

filename.

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);

track_num :

cd track number.

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);

Returns :

A new ParoleFile object.

Since 0.4


parole_file_new_with_display_name ()

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

filename :

filename.

Returns :

A new ParoleFile object.

Since 0.2


parole_file_set_custom_subtitles ()

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


parole_file_set_dvd_chapter ()

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

Property Details

The "content-type" property

  "content-type"             gchar*                : Read

The content type of the file.

Default value: NULL

Since 0.2


The "custom-subtitles" property

  "custom-subtitles"         gchar*                : Read / Write / Construct Only

The custom subtitles set by the user.

Default value: NULL


The "directory" property

  "directory"                gchar*                : Read / Write / Construct Only

The parent directory of the file.

Default value: NULL

Since 0.2


The "display-name" property

  "display-name"             gchar*                : Read / Write / Construct Only

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

Default value: NULL

Since 0.2


The "dvd-chapter" property

  "dvd-chapter"              gint                  : Read / Write / Construct Only

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

Allowed values: [G_MAXULONG,1000]

Default value: -1


The "filename" property

  "filename"                 gchar*                : Read / Write / Construct Only

The file name of the file.

Default value: NULL

Since 0.2


The "uri" property

  "uri"                      gchar*                : Read

The uri of the file.

Default value: NULL

Since 0.2