Namespace Grl

Index

Enumerations

Type Aliases

KeyID

Variables

Type Aliases

KeyID

KeyID: number

Variables

Const CONFIG_KEY_APIKEY

CONFIG_KEY_APIKEY: string

Const CONFIG_KEY_APIKEY_BLOB

CONFIG_KEY_APIKEY_BLOB: string

Const CONFIG_KEY_APISECRET

CONFIG_KEY_APISECRET: string

Const CONFIG_KEY_APITOKEN

CONFIG_KEY_APITOKEN: string

Const CONFIG_KEY_APITOKEN_SECRET

CONFIG_KEY_APITOKEN_SECRET: string

Const CONFIG_KEY_PASSWORD

CONFIG_KEY_PASSWORD: string

Const CONFIG_KEY_PLUGIN

CONFIG_KEY_PLUGIN: string

Const CONFIG_KEY_SOURCE

CONFIG_KEY_SOURCE: string

Const CONFIG_KEY_USERNAME

CONFIG_KEY_USERNAME: string

Const COUNT_INFINITY

COUNT_INFINITY: number

Const KEYID_FORMAT

KEYID_FORMAT: string

Const METADATA_KEY_ALBUM

METADATA_KEY_ALBUM: number

Const METADATA_KEY_ARTIST

METADATA_KEY_ARTIST: number

Const METADATA_KEY_AUDIO_TRACK

METADATA_KEY_AUDIO_TRACK: number

Const METADATA_KEY_AUTHOR

METADATA_KEY_AUTHOR: number

Const METADATA_KEY_BITRATE

METADATA_KEY_BITRATE: number

Const METADATA_KEY_CAMERA_MODEL

METADATA_KEY_CAMERA_MODEL: number

Const METADATA_KEY_CERTIFICATE

METADATA_KEY_CERTIFICATE: number

Const METADATA_KEY_CHILDCOUNT

METADATA_KEY_CHILDCOUNT: number

Const METADATA_KEY_CHILDCOUNT_UNKNOWN

METADATA_KEY_CHILDCOUNT_UNKNOWN: number

Const METADATA_KEY_CREATION_DATE

METADATA_KEY_CREATION_DATE: number

Const METADATA_KEY_DESCRIPTION

METADATA_KEY_DESCRIPTION: number

Const METADATA_KEY_DIRECTOR

METADATA_KEY_DIRECTOR: number

Const METADATA_KEY_DURATION

METADATA_KEY_DURATION: number

Const METADATA_KEY_EPISODE

METADATA_KEY_EPISODE: number

Const METADATA_KEY_EPISODE_TITLE

METADATA_KEY_EPISODE_TITLE: number

Const METADATA_KEY_EXPOSURE_TIME

METADATA_KEY_EXPOSURE_TIME: number

Const METADATA_KEY_EXTERNAL_PLAYER

METADATA_KEY_EXTERNAL_PLAYER: number

Const METADATA_KEY_EXTERNAL_URL

METADATA_KEY_EXTERNAL_URL: number

Const METADATA_KEY_FAVOURITE

METADATA_KEY_FAVOURITE: number

Const METADATA_KEY_FLASH_USED

METADATA_KEY_FLASH_USED: number

Const METADATA_KEY_FRAMERATE

METADATA_KEY_FRAMERATE: number

Const METADATA_KEY_GENRE

METADATA_KEY_GENRE: number

Const METADATA_KEY_HEIGHT

METADATA_KEY_HEIGHT: number

Const METADATA_KEY_ID

METADATA_KEY_ID: number

Const METADATA_KEY_INVALID

METADATA_KEY_INVALID: number

Const METADATA_KEY_ISO_SPEED

METADATA_KEY_ISO_SPEED: number

Const METADATA_KEY_KEYWORD

METADATA_KEY_KEYWORD: number

Const METADATA_KEY_LAST_PLAYED

METADATA_KEY_LAST_PLAYED: number

Const METADATA_KEY_LAST_POSITION

METADATA_KEY_LAST_POSITION: number

Const METADATA_KEY_LICENSE

METADATA_KEY_LICENSE: number

Const METADATA_KEY_LYRICS

METADATA_KEY_LYRICS: number

Const METADATA_KEY_MB_ALBUM_ID

METADATA_KEY_MB_ALBUM_ID: number

Const METADATA_KEY_MB_ARTIST_ID

METADATA_KEY_MB_ARTIST_ID: number

Const METADATA_KEY_MB_RECORDING_ID

METADATA_KEY_MB_RECORDING_ID: number

Const METADATA_KEY_MB_TRACK_ID

METADATA_KEY_MB_TRACK_ID: number

Const METADATA_KEY_MIME

METADATA_KEY_MIME: number

Const METADATA_KEY_MODIFICATION_DATE

METADATA_KEY_MODIFICATION_DATE: number

Const METADATA_KEY_ORIENTATION

METADATA_KEY_ORIENTATION: number

Const METADATA_KEY_ORIGINAL_TITLE

METADATA_KEY_ORIGINAL_TITLE: number

Const METADATA_KEY_PERFORMER

METADATA_KEY_PERFORMER: number

Const METADATA_KEY_PLAY_COUNT

METADATA_KEY_PLAY_COUNT: number

Const METADATA_KEY_PRODUCER

METADATA_KEY_PRODUCER: number

Const METADATA_KEY_PUBLICATION_DATE

METADATA_KEY_PUBLICATION_DATE: number

Const METADATA_KEY_RATING

METADATA_KEY_RATING: number

Const METADATA_KEY_REGION

METADATA_KEY_REGION: number

Const METADATA_KEY_SEASON

METADATA_KEY_SEASON: number

Const METADATA_KEY_SHOW

METADATA_KEY_SHOW: number

Const METADATA_KEY_SITE

METADATA_KEY_SITE: number

Const METADATA_KEY_SIZE

METADATA_KEY_SIZE: number

Const METADATA_KEY_SOURCE

METADATA_KEY_SOURCE: number

Const METADATA_KEY_START_TIME

METADATA_KEY_START_TIME: number

Const METADATA_KEY_STUDIO

METADATA_KEY_STUDIO: number

Const METADATA_KEY_THUMBNAIL

METADATA_KEY_THUMBNAIL: number

Const METADATA_KEY_THUMBNAIL_BINARY

METADATA_KEY_THUMBNAIL_BINARY: number

Const METADATA_KEY_TITLE

METADATA_KEY_TITLE: number

Const METADATA_KEY_TITLE_FROM_FILENAME

METADATA_KEY_TITLE_FROM_FILENAME: number

Const METADATA_KEY_TRACK_NUMBER

METADATA_KEY_TRACK_NUMBER: number

Const METADATA_KEY_URL

METADATA_KEY_URL: number

Const METADATA_KEY_WIDTH

METADATA_KEY_WIDTH: number

Const OPERATION_OPTION_COUNT

OPERATION_OPTION_COUNT: string

Const OPERATION_OPTION_KEY_EQUAL_FILTER

OPERATION_OPTION_KEY_EQUAL_FILTER: string

Const OPERATION_OPTION_KEY_RANGE_FILTER

OPERATION_OPTION_KEY_RANGE_FILTER: string

Const OPERATION_OPTION_RESOLUTION_FLAGS

OPERATION_OPTION_RESOLUTION_FLAGS: string

Const OPERATION_OPTION_SKIP

OPERATION_OPTION_SKIP: string

Const OPERATION_OPTION_TYPE_FILTER

OPERATION_OPTION_TYPE_FILTER: string

Const PADDING

PADDING: number

Const PADDING_SMALL

PADDING_SMALL: number

Const PLUGIN_AUTHOR

PLUGIN_AUTHOR: string

Const PLUGIN_DESCRIPTION

PLUGIN_DESCRIPTION: string

Const PLUGIN_LICENSE

PLUGIN_LICENSE: string

Const PLUGIN_LIST_VAR

PLUGIN_LIST_VAR: string

Const PLUGIN_NAME

PLUGIN_NAME: string

Const PLUGIN_PATH_VAR

PLUGIN_PATH_VAR: string

Const PLUGIN_RANKS_VAR

PLUGIN_RANKS_VAR: string

Const PLUGIN_SITE

PLUGIN_SITE: string

Const PLUGIN_VERSION

PLUGIN_VERSION: string

Const SOURCE_REMAINING_UNKNOWN

SOURCE_REMAINING_UNKNOWN: number

Functions

dateTimeFromIso8601

dateTimeFromIso8601(date: string): GLib.DateTime

- Defined in Grl-0.2.d.ts:425
Parameters
- date: string
Returns GLib.DateTime

deinit

deinit(): void

- Defined in Grl-0.2.d.ts:432
Deinitializes the Grilo library.

Call this function after finalizing using Grilo, in order to free and clean up all the resources created.

Returns void

gValueDup

gValueDup(value: any): any

- Defined in Grl-0.2.d.ts:433
Parameters
- value: any
Returns any

gValueFree

gValueFree(value: any): void

- Defined in Grl-0.2.d.ts:434
Parameters
- value: any
Returns void

gValueHashtableNew

gValueHashtableNew(): HashTable

- Defined in Grl-0.2.d.ts:435
Returns HashTable

gValueHashtableNewDirect

gValueHashtableNewDirect(): HashTable

- Defined in Grl-0.2.d.ts:436
Returns HashTable

gValueNew

gValueNew(gType: GType<unknown>): any

- Defined in Grl-0.2.d.ts:437
Parameters
- gType: GType<unknown>
Returns any

init

init(argv: string[]): string[] | null

- Defined in Grl-0.2.d.ts:442
Initializes the Grilo library

Parameters
- argv: string[]
  
  list of arguments
Returns string[] | null

initGetOptionGroup

initGetOptionGroup(): OptionGroup

- Defined in Grl-0.2.d.ts:450
Returns a #GOptionGroup with Grilo's argument specifications.

This function is useful if you want to integrate Grilo with other libraries that use the GOption commandline parser (see g_option_context_add_group() ).

Returns OptionGroup

logConfigure

logConfigure(config: string): void

Configure a set of log domains. The default configuration is to display warning and error messages only for all the log domains.

The configuration string follows the following grammar:



examples:
<itemizedlist>
  <listitem><para>"*:*": maximum verbosity for all the log domains</para>
  </listitem>
  <listitem><para>"*:-": don't print any message</para></listitem>
  <listitem><para>"media-source:debug,metadata-source:debug": prints debug,
  info, message warning and error messages for the media-source and
  metadata-source log domains</para></listitem>
</itemizedlist>

<note>It's possible to override the log configuration at runtime by
defining the GRL_DEBUG environment variable to a configuration string
as described above</note>
@param config A string describing the wanted log configuration

Parameters

config: string

Returns void

marshalVOIDBOXEDENUMBOOLEAN

marshalVOIDBOXEDENUMBOOLEAN(closure: TClosure<any, any>, returnValue: any, nParamValues: number, paramValues: any, invocationHint: object, marshalData: object): void

- Defined in Grl-0.2.d.ts:483
Parameters
- closure: TClosure<any, any>
- returnValue: any
- nParamValues: number
- paramValues: any
- invocationHint: object
- marshalData: object
Returns void

metadataKeyGetDesc

metadataKeyGetDesc(key: number): string

- Defined in Grl-0.2.d.ts:488
Retrieves the description associated with the key

Parameters
- key: number
  
  key to look up
Returns string

metadataKeyGetName

metadataKeyGetName(key: number): string

- Defined in Grl-0.2.d.ts:493
Retrieves the name associated with the key

Parameters
- key: number
  
  key to look up
Returns string

metadataKeyGetType

metadataKeyGetType(key: number): GType

- Defined in Grl-0.2.d.ts:498
Retrieves the expected type for values associated with this key

Parameters
- key: number
  
  key to look up
Returns GType

metadataKeySetupSystemKeys

metadataKeySetupSystemKeys(registry: Grl.Registry): void

- Defined in Grl-0.2.d.ts:499
Parameters
- registry: Grl.Registry
Returns void

multipleGetMediaFromUri

multipleGetMediaFromUri(uri: string, keys: number[], options: Grl.OperationOptions, callback: Grl.SourceResolveCb): void

- Defined in Grl-0.2.d.ts:511
Goes though all available media sources until it finds one capable of constructing a GrlMedia object representing the media resource exposed by uri.

This method is asynchronous.

Parameters
- uri: string
  
  A URI that can be used to identify a media resource
- keys: number[]
  
  List of metadata keys we want to obtain.
- options: Grl.OperationOptions
  
  options wanted for that operation
- callback: Grl.SourceResolveCb
  
  the user defined callback
Returns void

multipleSearch

multipleSearch(sources: Grl.Source[], text: string, keys: number[], options: Grl.OperationOptions, callback: Grl.SourceResultCb): number

- Defined in Grl-0.2.d.ts:525
Search for text in all the sources specified in sources.

If text is NULL then NULL-text searchs will be used for each searchable plugin (see #grl_source_search for more details).

This method is asynchronous.

Parameters
- sources: Grl.Source[]
  
  a #GList of #GrlSources to search from (%NULL for all searchable sources)
- text: string
  
  the text to search for
- keys: number[]
  
  the #GList of #GrlKeyID to retrieve
- options: Grl.OperationOptions
  
  options wanted for that operation
- callback: Grl.SourceResultCb
  
  the user defined callback
Returns number

multipleSearchSync

multipleSearchSync(sources: Grl.Source[], text: string, keys: number[], options: Grl.OperationOptions): Grl.Media[]

- Defined in Grl-0.2.d.ts:535
Search for text in all the sources specified in sources.

This method is synchronous.

Parameters
- sources: Grl.Source[]
  
  a #GList of #GrlSources where to search from (%NULL for all available sources with search capability)
- text: string
  
  the text to search for
- keys: number[]
  
  the #GList of #GrlKeyID to retrieve
- options: Grl.OperationOptions
  
  options wanted for that operation
Returns Grl.Media[]

operationCancel

operationCancel(operationId: number): void

- Defined in Grl-0.2.d.ts:540
Cancel an operation.

Parameters
- operationId: number
  
  the identifier of a running operation
Returns void

operationGenerateId

operationGenerateId(): number

- Defined in Grl-0.2.d.ts:541
Returns number

operationGetData

operationGetData(operationId: number): object | null

- Defined in Grl-0.2.d.ts:546
Obtains the previously attached data

Parameters
- operationId: number
  
  the identifier of a running operation
Returns object | null

operationInit

operationInit(): void

- Defined in Grl-0.2.d.ts:547
Returns void

operationRemove

operationRemove(operationId: number): void

- Defined in Grl-0.2.d.ts:548
Parameters
- operationId: number
Returns void

operationSetData

operationSetData(operationId: number, userData: object): void

- Defined in Grl-0.2.d.ts:554
Attach a pointer to the specific operation.

Parameters
- operationId: number
  
  the identifier of a running operation
- userData: object
  
  the data to attach
Returns void

operationSetDataFull

operationSetDataFull(operationId: number, userData: object, destroyFunc: GLib.DestroyNotify): void

- Defined in Grl-0.2.d.ts:563
Attach a pointer to the specific operation.

Note that the destroy_func callback is not called if user_data is %NULL.

Parameters
- operationId: number
  
  the identifier of a running operation
- userData: object
  
  the data to attach
- destroyFunc: GLib.DestroyNotify
  
  function to release user_data when the operation terminates
Returns void

operationSetPrivateData

operationSetPrivateData(operationId: number, privateData: object, cancelCb: OperationCancelCb): void

- Defined in Grl-0.2.d.ts:564
Parameters
- operationId: number
- privateData: object
- cancelCb: OperationCancelCb
Returns void

pagingTranslate

pagingTranslate(skip: number, count: number, maxPageSize: number, pageSize: number, pageNumber: number, internalOffset: number): void

- Defined in Grl-0.2.d.ts:590
Grilo browsing implements a paging mechanism through skip and count values.

But there are some services (like Jamendo or Flickr) where paging is done through a page number and page size: user request all elements in a page, specifying in most cases what is the page size.

This function is a helper for this task, computing from skip and count what is the optimal value of page size (limited by max_page_size), which page should the user request, and where requested data start inside the page.

By optimal we mean that it computes those values so only one page is required to satisfy the data, using the smallest page size. If user is limiting page size, then more requests to services might be needed. But still page size will be an optimal value.

If page_size is NULL, then page size will be max_page_size. If the later is also 0, then page size will be #G_MAXUINT.

Parameters
- skip: number
  
  number of elements to skip
- count: number
  
  number of elements to retrieve
- maxPageSize: number
  
  maximum value for page size (0 for unlimited size)
- pageSize: number
  
  optimal page size
- pageNumber: number
  
  page which contain the first element to retrieve (starting at 1)
- internalOffset: number
  
  in the page_number, offset where first element can be found (starting at 0)
Returns void

rangeValueHashtableInsert

rangeValueHashtableInsert(hashTable: HashTable<string | number | symbol, string | number | boolean>, key: object, min: any, max: any): void

- Defined in Grl-0.2.d.ts:591
Parameters
- hashTable: HashTable<string | number | symbol, string | number | boolean>
- key: object
- min: any
- max: any
Returns void

rangeValueHashtableNew

rangeValueHashtableNew(): HashTable

- Defined in Grl-0.2.d.ts:592
Returns HashTable

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

KeyID

Variables

Const CONFIG_KEY_APIKEY

Const CONFIG_KEY_APIKEY_BLOB

Const CONFIG_KEY_APISECRET

Const CONFIG_KEY_APITOKEN

Const CONFIG_KEY_APITOKEN_SECRET

Const CONFIG_KEY_PASSWORD

Const CONFIG_KEY_PLUGIN

Const CONFIG_KEY_SOURCE

Const CONFIG_KEY_USERNAME

Const COUNT_INFINITY

Const KEYID_FORMAT

Const METADATA_KEY_ALBUM

Const METADATA_KEY_ARTIST

Const METADATA_KEY_AUDIO_TRACK

Const METADATA_KEY_AUTHOR

Const METADATA_KEY_BITRATE

Const METADATA_KEY_CAMERA_MODEL

Const METADATA_KEY_CERTIFICATE

Const METADATA_KEY_CHILDCOUNT

Const METADATA_KEY_CHILDCOUNT_UNKNOWN

Const METADATA_KEY_CREATION_DATE

Const METADATA_KEY_DESCRIPTION

Const METADATA_KEY_DIRECTOR

Const METADATA_KEY_DURATION

Const METADATA_KEY_EPISODE

Const METADATA_KEY_EPISODE_TITLE

Const METADATA_KEY_EXPOSURE_TIME

Const METADATA_KEY_EXTERNAL_PLAYER

Const METADATA_KEY_EXTERNAL_URL

Const METADATA_KEY_FAVOURITE

Const METADATA_KEY_FLASH_USED

Const METADATA_KEY_FRAMERATE

Const METADATA_KEY_GENRE

Const METADATA_KEY_HEIGHT

Const METADATA_KEY_ID

Const METADATA_KEY_INVALID

Const METADATA_KEY_ISO_SPEED

Const METADATA_KEY_KEYWORD

Const METADATA_KEY_LAST_PLAYED

Const METADATA_KEY_LAST_POSITION

Const METADATA_KEY_LICENSE

Const METADATA_KEY_LYRICS

Const METADATA_KEY_MB_ALBUM_ID

Const METADATA_KEY_MB_ARTIST_ID

Const METADATA_KEY_MB_RECORDING_ID

Const METADATA_KEY_MB_TRACK_ID

Const METADATA_KEY_MIME

Const METADATA_KEY_MODIFICATION_DATE

Const METADATA_KEY_ORIENTATION

Const METADATA_KEY_ORIGINAL_TITLE

Const METADATA_KEY_PERFORMER

Const METADATA_KEY_PLAY_COUNT

Const METADATA_KEY_PRODUCER

Const METADATA_KEY_PUBLICATION_DATE

Const METADATA_KEY_RATING

Const METADATA_KEY_REGION

Const METADATA_KEY_SEASON

Const METADATA_KEY_SHOW

Const METADATA_KEY_SITE

Const METADATA_KEY_SIZE

Const METADATA_KEY_SOURCE

Const METADATA_KEY_START_TIME

Const METADATA_KEY_STUDIO

Const METADATA_KEY_THUMBNAIL

Const METADATA_KEY_THUMBNAIL_BINARY

Const METADATA_KEY_TITLE

Const METADATA_KEY_TITLE_FROM_FILENAME

Const METADATA_KEY_TRACK_NUMBER

Const METADATA_KEY_URL

Const METADATA_KEY_WIDTH