Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

KeyID: number

Variables

CONFIG_KEY_APIKEY: string
CONFIG_KEY_APIKEY_BLOB: string
CONFIG_KEY_APISECRET: string
CONFIG_KEY_APITOKEN: string
CONFIG_KEY_APITOKEN_SECRET: string
CONFIG_KEY_PASSWORD: string
CONFIG_KEY_PLUGIN: string
CONFIG_KEY_SOURCE: string
CONFIG_KEY_USERNAME: string
COUNT_INFINITY: number
KEYID_FORMAT: string
METADATA_KEY_ALBUM: number
METADATA_KEY_ARTIST: number
METADATA_KEY_AUDIO_TRACK: number
METADATA_KEY_AUTHOR: number
METADATA_KEY_BITRATE: number
METADATA_KEY_CAMERA_MODEL: number
METADATA_KEY_CERTIFICATE: number
METADATA_KEY_CHILDCOUNT: number
METADATA_KEY_CHILDCOUNT_UNKNOWN: number
METADATA_KEY_CREATION_DATE: number
METADATA_KEY_DESCRIPTION: number
METADATA_KEY_DIRECTOR: number
METADATA_KEY_DURATION: number
METADATA_KEY_EPISODE: number
METADATA_KEY_EPISODE_TITLE: number
METADATA_KEY_EXPOSURE_TIME: number
METADATA_KEY_EXTERNAL_PLAYER: number
METADATA_KEY_EXTERNAL_URL: number
METADATA_KEY_FAVOURITE: number
METADATA_KEY_FLASH_USED: number
METADATA_KEY_FRAMERATE: number
METADATA_KEY_GENRE: number
METADATA_KEY_HEIGHT: number
METADATA_KEY_ID: number
METADATA_KEY_INVALID: number
METADATA_KEY_ISO_SPEED: number
METADATA_KEY_KEYWORD: number
METADATA_KEY_LAST_PLAYED: number
METADATA_KEY_LAST_POSITION: number
METADATA_KEY_LICENSE: number
METADATA_KEY_LYRICS: number
METADATA_KEY_MB_ALBUM_ID: number
METADATA_KEY_MB_ARTIST_ID: number
METADATA_KEY_MB_RECORDING_ID: number
METADATA_KEY_MB_TRACK_ID: number
METADATA_KEY_MIME: number
METADATA_KEY_MODIFICATION_DATE: number
METADATA_KEY_ORIENTATION: number
METADATA_KEY_ORIGINAL_TITLE: number
METADATA_KEY_PERFORMER: number
METADATA_KEY_PLAY_COUNT: number
METADATA_KEY_PRODUCER: number
METADATA_KEY_PUBLICATION_DATE: number
METADATA_KEY_RATING: number
METADATA_KEY_REGION: number
METADATA_KEY_SEASON: number
METADATA_KEY_SHOW: number
METADATA_KEY_SITE: number
METADATA_KEY_SIZE: number
METADATA_KEY_SOURCE: number
METADATA_KEY_START_TIME: number
METADATA_KEY_STUDIO: number
METADATA_KEY_THUMBNAIL: number
METADATA_KEY_THUMBNAIL_BINARY: number
METADATA_KEY_TITLE: number
METADATA_KEY_TITLE_FROM_FILENAME: number
METADATA_KEY_TRACK_NUMBER: number
METADATA_KEY_URL: number
METADATA_KEY_WIDTH: number
OPERATION_OPTION_COUNT: string
OPERATION_OPTION_KEY_EQUAL_FILTER: string
OPERATION_OPTION_KEY_RANGE_FILTER: string
OPERATION_OPTION_RESOLUTION_FLAGS: string
OPERATION_OPTION_SKIP: string
OPERATION_OPTION_TYPE_FILTER: string
PADDING: number
PADDING_SMALL: number
PLUGIN_AUTHOR: string
PLUGIN_DESCRIPTION: string
PLUGIN_LICENSE: string
PLUGIN_LIST_VAR: string
PLUGIN_NAME: string
PLUGIN_PATH_VAR: string
PLUGIN_RANKS_VAR: string
PLUGIN_SITE: string
PLUGIN_VERSION: string
SOURCE_REMAINING_UNKNOWN: number

Functions

  • deinit(): void
  • 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(value: any): any
  • gValueFree(value: any): void
  • gValueNew(gType: GType<unknown>): any
  • init(argv: string[]): string[] | null
  • Initializes the Grilo library

    Parameters

    • argv: string[]

      list of arguments

    Returns string[] | null

  • 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(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:

    |[ config-list: config | config ',' config-list config: domain ':' level domain: '' | [a-zA-Z0-9]+ level: '' | '-' | named-level | num-level named-level: "none" | "error" | "warning" | "message" | "info" | "debug" num-level: [0-5]



    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(closure: TClosure<any, any>, returnValue: any, nParamValues: number, paramValues: any, invocationHint: object, marshalData: object): void
  • Parameters

    • closure: TClosure<any, any>
    • returnValue: any
    • nParamValues: number
    • paramValues: any
    • invocationHint: object
    • marshalData: object

    Returns void

  • metadataKeyGetDesc(key: number): string
  • Retrieves the description associated with the key

    Parameters

    • key: number

      key to look up

    Returns string

  • metadataKeyGetName(key: number): string
  • Retrieves the name associated with the key

    Parameters

    • key: number

      key to look up

    Returns string

  • metadataKeyGetType(key: number): GType
  • Retrieves the expected type for values associated with this key

    Parameters

    • key: number

      key to look up

    Returns GType

  • metadataKeySetupSystemKeys(registry: Grl.Registry): void
  • 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

  • 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

  • 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(operationId: number): void
  • Cancel an operation.

    Parameters

    • operationId: number

      the identifier of a running operation

    Returns void

  • operationGenerateId(): number
  • operationGetData(operationId: number): object | null
  • Obtains the previously attached data

    Parameters

    • operationId: number

      the identifier of a running operation

    Returns object | null

  • operationInit(): void
  • operationRemove(operationId: number): void
  • operationSetData(operationId: number, userData: object): void
  • 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(operationId: number, userData: object, destroyFunc: GLib.DestroyNotify): void
  • 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(operationId: number, privateData: object, cancelCb: OperationCancelCb): void
  • pagingTranslate(skip: number, count: number, maxPageSize: number, pageSize: number, pageNumber: number, internalOffset: number): void
  • 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(hashTable: HashTable<string | number | symbol, string | number | boolean>, key: object, min: any, max: any): void
  • Parameters

    • hashTable: HashTable<string | number | symbol, string | number | boolean>
    • key: object
    • min: any
    • max: any

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method