ParoleStream: Parole Plugins Reference Manual

## ParoleStream ParoleStream |

## Properties

gint64 | absolute-duration | Read / Write
gchar * | album | Read / Write
gchar * | artist | Read / Write
guint | bitrate | Read / Write
gchar * | comment | Read / Write
guint | disp-par-d | Read / Write
guint | disp-par-n | Read / Write
gint64 | duration | Read / Write
gchar * | genre | Read / Write
gboolean | has-audio | Read / Write
gboolean | has-video | Read / Write
gchar * | image-uri | Read / Write
gboolean | live | Read / Write
ParoleMediaType | media-type | Read / Write
guint | num-tracks | Read / Write
gboolean | seekable | Read / Write
gchar * | subtitles | Read / Write
gboolean | tag-available | Read / Write
gchar * | title | Read / Write
guint | track | Read / Write
gchar * | uri | Read / Write
gint | video-height | Read / Write
gint | video-width | Read / Write
gchar * | year | Read / Write

## Types and Values

enum | ParoleMediaType
struct | ParoleStream

## Object Hierarchy

        GObject
        ╰── ParoleStream

## Description

## Functions

## Types and Values

### enum ParoleMediaType

Media types.

#### Members

PAROLE_MEDIA_TYPE_UNKNOWN | Unknown media type |
PAROLE_MEDIA_TYPE_LOCAL_FILE | File found on hard disk |
PAROLE_MEDIA_TYPE_CDDA | Audio CD |
PAROLE_MEDIA_TYPE_VCD | Video CD |
PAROLE_MEDIA_TYPE_SVCD | Super Video CD |
PAROLE_MEDIA_TYPE_DVD | DVD |
PAROLE_MEDIA_TYPE_DVB | Digital Video Broadcast |
PAROLE_MEDIA_TYPE_REMOTE | File stored remotely |

### struct ParoleStream

    struct ParoleStream;

This object contains all the information describing the current processed stream by Parole, this object is used with the callback function the “state-changed” signal of the player, the plugin shouldn't take reference and all the properties are read-only for the plugins.

Since: 0.2

## Property Details

### The `“absolute-duration”` property

      “absolute-duration”        gint64

Absolution duration.

Flags: Read / Write

Allowed values: >= 0

Default value: 0

Since: 0.2

### The `“album”` property

      “album”                    gchar *

Album.

Flags: Read / Write

Default value: NULL

Since: 0.2

### The `“artist”` property

      “artist”                   gchar *

Artist.

Flags: Read / Write

Default value: NULL

Since: 0.2

### The `“bitrate”` property

      “bitrate”                  guint

Current bitrate in bits/s.

Flags: Read / Write

Allowed values: <= G_MAXINT

Default value: 0

Since: 0.6

### The `“comment”` property

      “comment”                  gchar *

Extra comment block.

Flags: Read / Write

Default value: NULL

Since: 0.2

### The `“disp-par-d”` property

      “disp-par-d”               guint

Disp par d.

Flags: Read / Write

Allowed values: >= 1

Default value: 1

### The `“disp-par-n”` property

      “disp-par-n”               guint

Disp par n.

Flags: Read / Write

Allowed values: >= 1

Default value: 1

Since: 0.2

### The `“duration”` property

      “duration”                 gint64

Duration.

Flags: Read / Write

Allowed values: >= 0

Default value: 0

Since: 0.2

### The `“genre”` property

      “genre”                    gchar *

Genre.

Flags: Read / Write

Default value: NULL

Since: 0.6

### The `“has-audio”` property

      “has-audio”                gboolean

Whether the stream has audio.

Flags: Read / Write

Default value: FALSE

Since: 0.2

### The `“has-video”` property

      “has-video”                gboolean

Whether the stream has video.

Flags: Read / Write

Default value: FALSE

Since: 0.2

### The `“image-uri”` property

      “image-uri”                gchar *

URI for the album artwork.

Flags: Read / Write

Default value: NULL

### The `“live”` property

      “live”                     gboolean

Whether the stream is a live stream.

Flags: Read / Write

Default value: FALSE

Since: 0.2

### The `“media-type”` property

      “media-type”               ParoleMediaType

The media type.

Flags: Read / Write

Default value: PAROLE_MEDIA_TYPE_UNKNOWN

Since: 0.2

### The `“num-tracks”` property

      “num-tracks”               guint

Number of tracks in the cdda source, only valid if ParoleStream:media-type: is PAROLE_MEDIA_TYPE_CDDA.

Flags: Read / Write

Allowed values: [1,99]

Default value: 1

Since: 0.2

### The `“seekable”` property

      “seekable”                 gboolean

Whether the stream is seekable, for example live streams are not seekable.

Flags: Read / Write

Default value: FALSE

Since: 0.2

### The `“subtitles”` property

      “subtitles”                gchar *

Subtitles path, this is only valid if the property "media-type" has the value PAROLE_MEDIA_TYPE_LOCAL_FILE.

Flags: Read / Write

Default value: NULL

Since: 0.2

### The `“tag-available”` property

      “tag-available”            gboolean

Whether tags information are available on the current stream.

Flags: Read / Write

Default value: FALSE

Since: 0.2

### The `“title”` property

      “title”                    gchar *

Title.

Flags: Read / Write

Default value: NULL

Since: 0.2

### The `“track”` property

      “track”                    guint

Currently playing track, this is only valid if “media-type”: is PAROLE_MEDIA_TYPE_CDDA or PAROLE_MEDIA_TYPE_DVD.

Flags: Read / Write

Allowed values: <= 99

Default value: 1

Since: 0.2

### The `“uri”` property

      “uri”                      gchar *

Currently loaded uri.

Flags: Read / Write

Default value: NULL

Since: 0.2

### The `“video-height”` property

      “video-height”             gint

Video height.

Flags: Read / Write

Allowed values: >= 0

Default value: 0

Since: 0.2

### The `“video-width”` property

      “video-width”              gint

Video width.

Flags: Read / Write

Allowed values: >= 0

Default value: 0

Since: 0.2

### The `“year”` property

      “year”                     gchar *

Year.

Flags: Read / Write

Default value: NULL

Since: 0.2