@girs/grl-0.2 0.2.0-3.2.6 → 0.2.0-3.2.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/grl-0.2.d.cts +220 -220
- package/grl-0.2.d.ts +220 -220
- package/package.json +6 -6
package/grl-0.2.d.cts
CHANGED
|
@@ -334,17 +334,17 @@ export enum WriteFlags {
|
|
|
334
334
|
*/
|
|
335
335
|
FULL,
|
|
336
336
|
}
|
|
337
|
-
export const CONFIG_KEY_APIKEY: string
|
|
338
|
-
export const CONFIG_KEY_APIKEY_BLOB: string
|
|
339
|
-
export const CONFIG_KEY_APISECRET: string
|
|
340
|
-
export const CONFIG_KEY_APITOKEN: string
|
|
341
|
-
export const CONFIG_KEY_APITOKEN_SECRET: string
|
|
342
|
-
export const CONFIG_KEY_PASSWORD: string
|
|
343
|
-
export const CONFIG_KEY_PLUGIN: string
|
|
344
|
-
export const CONFIG_KEY_SOURCE: string
|
|
345
|
-
export const CONFIG_KEY_USERNAME: string
|
|
337
|
+
export const CONFIG_KEY_APIKEY: string
|
|
338
|
+
export const CONFIG_KEY_APIKEY_BLOB: string
|
|
339
|
+
export const CONFIG_KEY_APISECRET: string
|
|
340
|
+
export const CONFIG_KEY_APITOKEN: string
|
|
341
|
+
export const CONFIG_KEY_APITOKEN_SECRET: string
|
|
342
|
+
export const CONFIG_KEY_PASSWORD: string
|
|
343
|
+
export const CONFIG_KEY_PLUGIN: string
|
|
344
|
+
export const CONFIG_KEY_SOURCE: string
|
|
345
|
+
export const CONFIG_KEY_USERNAME: string
|
|
346
346
|
export const COUNT_INFINITY: number
|
|
347
|
-
export const KEYID_FORMAT: string
|
|
347
|
+
export const KEYID_FORMAT: string
|
|
348
348
|
export const METADATA_KEY_ALBUM: number
|
|
349
349
|
export const METADATA_KEY_ARTIST: number
|
|
350
350
|
export const METADATA_KEY_AUDIO_TRACK: number
|
|
@@ -404,25 +404,25 @@ export const METADATA_KEY_TITLE_FROM_FILENAME: number
|
|
|
404
404
|
export const METADATA_KEY_TRACK_NUMBER: number
|
|
405
405
|
export const METADATA_KEY_URL: number
|
|
406
406
|
export const METADATA_KEY_WIDTH: number
|
|
407
|
-
export const OPERATION_OPTION_COUNT: string
|
|
408
|
-
export const OPERATION_OPTION_KEY_EQUAL_FILTER: string
|
|
409
|
-
export const OPERATION_OPTION_KEY_RANGE_FILTER: string
|
|
410
|
-
export const OPERATION_OPTION_RESOLUTION_FLAGS: string
|
|
411
|
-
export const OPERATION_OPTION_SKIP: string
|
|
412
|
-
export const OPERATION_OPTION_TYPE_FILTER: string
|
|
407
|
+
export const OPERATION_OPTION_COUNT: string
|
|
408
|
+
export const OPERATION_OPTION_KEY_EQUAL_FILTER: string
|
|
409
|
+
export const OPERATION_OPTION_KEY_RANGE_FILTER: string
|
|
410
|
+
export const OPERATION_OPTION_RESOLUTION_FLAGS: string
|
|
411
|
+
export const OPERATION_OPTION_SKIP: string
|
|
412
|
+
export const OPERATION_OPTION_TYPE_FILTER: string
|
|
413
413
|
export const PADDING: number
|
|
414
414
|
export const PADDING_SMALL: number
|
|
415
|
-
export const PLUGIN_AUTHOR: string
|
|
416
|
-
export const PLUGIN_DESCRIPTION: string
|
|
417
|
-
export const PLUGIN_LICENSE: string
|
|
418
|
-
export const PLUGIN_LIST_VAR: string
|
|
419
|
-
export const PLUGIN_NAME: string
|
|
420
|
-
export const PLUGIN_PATH_VAR: string
|
|
421
|
-
export const PLUGIN_RANKS_VAR: string
|
|
422
|
-
export const PLUGIN_SITE: string
|
|
423
|
-
export const PLUGIN_VERSION: string
|
|
415
|
+
export const PLUGIN_AUTHOR: string
|
|
416
|
+
export const PLUGIN_DESCRIPTION: string
|
|
417
|
+
export const PLUGIN_LICENSE: string
|
|
418
|
+
export const PLUGIN_LIST_VAR: string
|
|
419
|
+
export const PLUGIN_NAME: string
|
|
420
|
+
export const PLUGIN_PATH_VAR: string
|
|
421
|
+
export const PLUGIN_RANKS_VAR: string
|
|
422
|
+
export const PLUGIN_SITE: string
|
|
423
|
+
export const PLUGIN_VERSION: string
|
|
424
424
|
export const SOURCE_REMAINING_UNKNOWN: number
|
|
425
|
-
export function date_time_from_iso8601(date: string
|
|
425
|
+
export function date_time_from_iso8601(date: string): GLib.DateTime
|
|
426
426
|
/**
|
|
427
427
|
* Deinitializes the Grilo library.
|
|
428
428
|
*
|
|
@@ -481,20 +481,20 @@ export function init_get_option_group(): GLib.OptionGroup
|
|
|
481
481
|
* as described above</note>
|
|
482
482
|
* @param config A string describing the wanted log configuration
|
|
483
483
|
*/
|
|
484
|
-
export function log_configure(config: string
|
|
484
|
+
export function log_configure(config: string): void
|
|
485
485
|
export function marshal_VOID__BOXED_ENUM_BOOLEAN(closure: GObject.TClosure, return_value: any, n_param_values: number, param_values: any, invocation_hint: any | null, marshal_data: any | null): void
|
|
486
486
|
/**
|
|
487
487
|
* Retrieves the description associated with the key
|
|
488
488
|
* @param key key to look up
|
|
489
489
|
* @returns the description of the key
|
|
490
490
|
*/
|
|
491
|
-
export function metadata_key_get_desc(key: KeyID): string
|
|
491
|
+
export function metadata_key_get_desc(key: KeyID): string
|
|
492
492
|
/**
|
|
493
493
|
* Retrieves the name associated with the key
|
|
494
494
|
* @param key key to look up
|
|
495
495
|
* @returns The name of the key
|
|
496
496
|
*/
|
|
497
|
-
export function metadata_key_get_name(key: KeyID): string
|
|
497
|
+
export function metadata_key_get_name(key: KeyID): string
|
|
498
498
|
/**
|
|
499
499
|
* Retrieves the expected type for values associated with this key
|
|
500
500
|
* @param key key to look up
|
|
@@ -513,7 +513,7 @@ export function metadata_key_setup_system_keys(registry: Registry): void
|
|
|
513
513
|
* @param options options wanted for that operation
|
|
514
514
|
* @param callback the user defined callback
|
|
515
515
|
*/
|
|
516
|
-
export function multiple_get_media_from_uri(uri: string
|
|
516
|
+
export function multiple_get_media_from_uri(uri: string, keys: KeyID[], options: OperationOptions, callback: SourceResolveCb): void
|
|
517
517
|
/**
|
|
518
518
|
* Search for `text` in all the sources specified in `sources`.
|
|
519
519
|
*
|
|
@@ -528,7 +528,7 @@ export function multiple_get_media_from_uri(uri: string | null, keys: KeyID[], o
|
|
|
528
528
|
* @param callback the user defined callback
|
|
529
529
|
* @returns the operation identifier
|
|
530
530
|
*/
|
|
531
|
-
export function multiple_search(sources: Source[] | null, text: string
|
|
531
|
+
export function multiple_search(sources: Source[] | null, text: string, keys: KeyID[], options: OperationOptions, callback: SourceResultCb): number
|
|
532
532
|
/**
|
|
533
533
|
* Search for `text` in all the sources specified in `sources`.
|
|
534
534
|
*
|
|
@@ -539,7 +539,7 @@ export function multiple_search(sources: Source[] | null, text: string | null, k
|
|
|
539
539
|
* @param options options wanted for that operation
|
|
540
540
|
* @returns a list with #GrlMedia elements
|
|
541
541
|
*/
|
|
542
|
-
export function multiple_search_sync(sources: Source[] | null, text: string
|
|
542
|
+
export function multiple_search_sync(sources: Source[] | null, text: string, keys: KeyID[], options: OperationOptions): Media[]
|
|
543
543
|
/**
|
|
544
544
|
* Cancel an operation.
|
|
545
545
|
* @param operation_id the identifier of a running operation
|
|
@@ -695,7 +695,7 @@ export interface Caps {
|
|
|
695
695
|
* @param value the value corresponding to `key` to test against `caps`
|
|
696
696
|
* @returns %TRUE if (@key, @value) obey to @caps, %FALSE otherwise.
|
|
697
697
|
*/
|
|
698
|
-
test_option(key: string
|
|
698
|
+
test_option(key: string, value: any): boolean
|
|
699
699
|
|
|
700
700
|
// Class property signals of Grl-0.2.Grl.Caps
|
|
701
701
|
|
|
@@ -761,27 +761,27 @@ export interface Config {
|
|
|
761
761
|
* @param size place for size of value
|
|
762
762
|
* @returns @param value
|
|
763
763
|
*/
|
|
764
|
-
get_binary(param: string
|
|
765
|
-
get_boolean(param: string
|
|
766
|
-
get_float(param: string
|
|
767
|
-
get_int(param: string
|
|
764
|
+
get_binary(param: string, size: number | null): number
|
|
765
|
+
get_boolean(param: string): boolean
|
|
766
|
+
get_float(param: string): number
|
|
767
|
+
get_int(param: string): number
|
|
768
768
|
get_password(): string | null
|
|
769
769
|
get_plugin(): string | null
|
|
770
770
|
get_source(): string | null
|
|
771
|
-
get_string(param: string
|
|
771
|
+
get_string(param: string): string | null
|
|
772
772
|
get_username(): string | null
|
|
773
|
-
has_param(param: string
|
|
773
|
+
has_param(param: string): boolean
|
|
774
774
|
/**
|
|
775
775
|
* Set `param` `value`.
|
|
776
776
|
* @param param a parameter
|
|
777
777
|
* @param value value
|
|
778
778
|
*/
|
|
779
|
-
set(param: string
|
|
779
|
+
set(param: string, value: any): void
|
|
780
780
|
/**
|
|
781
781
|
* Set the webservice API key in the configuration
|
|
782
782
|
* @param key the API key
|
|
783
783
|
*/
|
|
784
|
-
set_api_key(key: string
|
|
784
|
+
set_api_key(key: string): void
|
|
785
785
|
/**
|
|
786
786
|
* Set the binary API key in the configuration
|
|
787
787
|
* @param blob the binary API key blob
|
|
@@ -792,69 +792,69 @@ export interface Config {
|
|
|
792
792
|
* Set the webservice passphrase in the configuration
|
|
793
793
|
* @param secret the webservice passphrase
|
|
794
794
|
*/
|
|
795
|
-
set_api_secret(secret: string
|
|
795
|
+
set_api_secret(secret: string): void
|
|
796
796
|
/**
|
|
797
797
|
* Set the webservice API token in the configuration
|
|
798
798
|
* @param token the API token
|
|
799
799
|
*/
|
|
800
|
-
set_api_token(token: string
|
|
800
|
+
set_api_token(token: string): void
|
|
801
801
|
/**
|
|
802
802
|
* Set the webservice API token secret in the configuration
|
|
803
803
|
* (Needed by OAuth)
|
|
804
804
|
* @param secret the API token
|
|
805
805
|
*/
|
|
806
|
-
set_api_token_secret(secret: string
|
|
806
|
+
set_api_token_secret(secret: string): void
|
|
807
807
|
/**
|
|
808
808
|
* Set `param` value.
|
|
809
809
|
* @param param a binary type parameter
|
|
810
810
|
* @param blob a base64 encoded binary value
|
|
811
811
|
* @param size size of `value`
|
|
812
812
|
*/
|
|
813
|
-
set_binary(param: string
|
|
813
|
+
set_binary(param: string, blob: number, size: number): void
|
|
814
814
|
/**
|
|
815
815
|
* Set `param` `value`.
|
|
816
816
|
* @param param a boolean type parameter
|
|
817
817
|
* @param value a value
|
|
818
818
|
*/
|
|
819
|
-
set_boolean(param: string
|
|
819
|
+
set_boolean(param: string, value: boolean): void
|
|
820
820
|
/**
|
|
821
821
|
* Set `param` `value`.
|
|
822
822
|
* @param param a float type parameter
|
|
823
823
|
* @param value a value
|
|
824
824
|
*/
|
|
825
|
-
set_float(param: string
|
|
825
|
+
set_float(param: string, value: number): void
|
|
826
826
|
/**
|
|
827
827
|
* Set `param` `value`.
|
|
828
828
|
* @param param an integer type parameter
|
|
829
829
|
* @param value a value
|
|
830
830
|
*/
|
|
831
|
-
set_int(param: string
|
|
831
|
+
set_int(param: string, value: number): void
|
|
832
832
|
/**
|
|
833
833
|
* Set the password in the configuration
|
|
834
834
|
* @param password the password
|
|
835
835
|
*/
|
|
836
|
-
set_password(password: string
|
|
836
|
+
set_password(password: string): void
|
|
837
837
|
/**
|
|
838
838
|
* Set the plugin key in the configuration
|
|
839
839
|
* @param plugin the plugin id
|
|
840
840
|
*/
|
|
841
|
-
set_plugin(plugin: string
|
|
841
|
+
set_plugin(plugin: string): void
|
|
842
842
|
/**
|
|
843
843
|
* Set the source key in the configuration
|
|
844
844
|
* @param source the source id
|
|
845
845
|
*/
|
|
846
|
-
set_source(source: string
|
|
846
|
+
set_source(source: string): void
|
|
847
847
|
/**
|
|
848
848
|
* Set `param` `value`.
|
|
849
849
|
* @param param a string type parameter
|
|
850
850
|
* @param value a value
|
|
851
851
|
*/
|
|
852
|
-
set_string(param: string
|
|
852
|
+
set_string(param: string, value: string): void
|
|
853
853
|
/**
|
|
854
854
|
* Set the username in the configuration
|
|
855
855
|
* @param username the username
|
|
856
856
|
*/
|
|
857
|
-
set_username(username: string
|
|
857
|
+
set_username(username: string): void
|
|
858
858
|
|
|
859
859
|
// Class property signals of Grl-0.2.Grl.Config
|
|
860
860
|
|
|
@@ -884,7 +884,7 @@ export class Config extends GObject.Object {
|
|
|
884
884
|
* @param source source id for this configuration
|
|
885
885
|
* @returns a newly-allocated data config. The data config associated with the plugin should not be freed until the plugin has been unloaded.
|
|
886
886
|
*/
|
|
887
|
-
constructor(plugin: string
|
|
887
|
+
constructor(plugin: string, source: string | null)
|
|
888
888
|
/**
|
|
889
889
|
* Creates a new data config object that will be associated with a plugin
|
|
890
890
|
* (if `source` is NULL), or a specific source spawned from a plugin (if
|
|
@@ -895,7 +895,7 @@ export class Config extends GObject.Object {
|
|
|
895
895
|
* @param source source id for this configuration
|
|
896
896
|
* @returns a newly-allocated data config. The data config associated with the plugin should not be freed until the plugin has been unloaded.
|
|
897
897
|
*/
|
|
898
|
-
static new(plugin: string
|
|
898
|
+
static new(plugin: string, source: string | null): Config
|
|
899
899
|
_init(config?: Config.ConstructorProperties): void
|
|
900
900
|
}
|
|
901
901
|
|
|
@@ -963,7 +963,7 @@ export interface Data {
|
|
|
963
963
|
* @param key key to append
|
|
964
964
|
* @param strvalue the new value
|
|
965
965
|
*/
|
|
966
|
-
add_string(key: KeyID, strvalue: string
|
|
966
|
+
add_string(key: KeyID, strvalue: string): void
|
|
967
967
|
/**
|
|
968
968
|
* Makes a deep copy of `data` and all its contents.
|
|
969
969
|
* @returns a new #GrlData. Free it with #g_object_unref.
|
|
@@ -1052,7 +1052,7 @@ export interface Data {
|
|
|
1052
1052
|
* @param key key to use
|
|
1053
1053
|
* @returns string associated with @key, or %NULL in other case. Caller should not change nor free the value.
|
|
1054
1054
|
*/
|
|
1055
|
-
get_string(key: KeyID): string
|
|
1055
|
+
get_string(key: KeyID): string
|
|
1056
1056
|
/**
|
|
1057
1057
|
* Checks if `key` is in `data`.
|
|
1058
1058
|
* @param key key to search
|
|
@@ -1157,7 +1157,7 @@ export interface Data {
|
|
|
1157
1157
|
* @param key key to change or add
|
|
1158
1158
|
* @param strvalue the new value
|
|
1159
1159
|
*/
|
|
1160
|
-
set_string(key: KeyID, strvalue: string
|
|
1160
|
+
set_string(key: KeyID, strvalue: string): void
|
|
1161
1161
|
|
|
1162
1162
|
// Class property signals of Grl-0.2.Grl.Data
|
|
1163
1163
|
|
|
@@ -1213,34 +1213,34 @@ export interface Media {
|
|
|
1213
1213
|
* Adds a new author to `media`.
|
|
1214
1214
|
* @param author an author for `media`
|
|
1215
1215
|
*/
|
|
1216
|
-
add_author(author: string
|
|
1216
|
+
add_author(author: string): void
|
|
1217
1217
|
/**
|
|
1218
1218
|
* Adds a new external player to `media`.
|
|
1219
1219
|
* @param player an external player for `media`
|
|
1220
1220
|
*/
|
|
1221
|
-
add_external_player(player: string
|
|
1221
|
+
add_external_player(player: string): void
|
|
1222
1222
|
/**
|
|
1223
1223
|
* Adds a new external url to `media`.
|
|
1224
1224
|
* @param url an external url for `media`
|
|
1225
1225
|
*/
|
|
1226
|
-
add_external_url(url: string
|
|
1226
|
+
add_external_url(url: string): void
|
|
1227
1227
|
/**
|
|
1228
1228
|
* Adds the keyword describing the `media`.
|
|
1229
1229
|
* @param keyword a keyword describing the media
|
|
1230
1230
|
*/
|
|
1231
|
-
add_keyword(keyword: string
|
|
1231
|
+
add_keyword(keyword: string): void
|
|
1232
1232
|
/**
|
|
1233
1233
|
* Adds regional publication and certification information for `region`.
|
|
1234
1234
|
* @param region the region's ISO-3166-1 code
|
|
1235
1235
|
* @param publication_date the publication date
|
|
1236
1236
|
* @param certificate the age certification
|
|
1237
1237
|
*/
|
|
1238
|
-
add_region_data(region: string
|
|
1238
|
+
add_region_data(region: string, publication_date: GLib.DateTime, certificate: string): void
|
|
1239
1239
|
/**
|
|
1240
1240
|
* Adds a new thumbnail to `media`.
|
|
1241
1241
|
* @param thumbnail a thumbnail for `media`
|
|
1242
1242
|
*/
|
|
1243
|
-
add_thumbnail(thumbnail: string
|
|
1243
|
+
add_thumbnail(thumbnail: string): void
|
|
1244
1244
|
/**
|
|
1245
1245
|
* Adds a new thumbnail to `media`.
|
|
1246
1246
|
* @param thumbnail a buffer containing the thumbnail for `media`
|
|
@@ -1252,9 +1252,9 @@ export interface Media {
|
|
|
1252
1252
|
* @param url a media's URL
|
|
1253
1253
|
* @param mime th `url` mime type
|
|
1254
1254
|
*/
|
|
1255
|
-
add_url_data(url: string
|
|
1256
|
-
get_author(): string
|
|
1257
|
-
get_author_nth(index: number): string
|
|
1255
|
+
add_url_data(url: string, mime: string): void
|
|
1256
|
+
get_author(): string
|
|
1257
|
+
get_author_nth(index: number): string
|
|
1258
1258
|
/**
|
|
1259
1259
|
* Returns the media's first age certificate.
|
|
1260
1260
|
* This should usually be the media's most relevant
|
|
@@ -1262,27 +1262,27 @@ export interface Media {
|
|
|
1262
1262
|
* get other age certificates.
|
|
1263
1263
|
* @returns the media's age certification
|
|
1264
1264
|
*/
|
|
1265
|
-
get_certificate(): string
|
|
1265
|
+
get_certificate(): string
|
|
1266
1266
|
get_creation_date(): GLib.DateTime
|
|
1267
|
-
get_description(): string
|
|
1267
|
+
get_description(): string
|
|
1268
1268
|
get_duration(): number
|
|
1269
|
-
get_external_url(): string
|
|
1270
|
-
get_external_url_nth(index: number): string
|
|
1269
|
+
get_external_url(): string
|
|
1270
|
+
get_external_url_nth(index: number): string
|
|
1271
1271
|
get_favourite(): boolean
|
|
1272
|
-
get_id(): string
|
|
1273
|
-
get_keyword(): string
|
|
1274
|
-
get_keyword_nth(index: number): string
|
|
1275
|
-
get_last_played(): string
|
|
1272
|
+
get_id(): string
|
|
1273
|
+
get_keyword(): string
|
|
1274
|
+
get_keyword_nth(index: number): string
|
|
1275
|
+
get_last_played(): string
|
|
1276
1276
|
get_last_position(): number
|
|
1277
|
-
get_license(): string
|
|
1278
|
-
get_mime(): string
|
|
1277
|
+
get_license(): string
|
|
1278
|
+
get_mime(): string
|
|
1279
1279
|
get_modification_date(): GLib.DateTime
|
|
1280
1280
|
get_play_count(): number
|
|
1281
|
-
get_player(): string
|
|
1282
|
-
get_player_nth(index: number): string
|
|
1281
|
+
get_player(): string
|
|
1282
|
+
get_player_nth(index: number): string
|
|
1283
1283
|
get_publication_date(): GLib.DateTime
|
|
1284
1284
|
get_rating(): number
|
|
1285
|
-
get_region(): string
|
|
1285
|
+
get_region(): string
|
|
1286
1286
|
/**
|
|
1287
1287
|
* Returns the media's age certificate and publication date for the first region.
|
|
1288
1288
|
* This should usually be the media's most relevant region.
|
|
@@ -1290,7 +1290,7 @@ export interface Media {
|
|
|
1290
1290
|
* publication date for other regions.
|
|
1291
1291
|
* @returns the ISO-3166-1 of the region where the media was published (owned by @media).
|
|
1292
1292
|
*/
|
|
1293
|
-
get_region_data(): [ /* returnType */ string
|
|
1293
|
+
get_region_data(): [ /* returnType */ string, /* publication_date */ GLib.DateTime, /* certificate */ string ]
|
|
1294
1294
|
/**
|
|
1295
1295
|
* Returns the media's age certificate and publication date for one region.
|
|
1296
1296
|
* Use grl_data_length() with GRL_METADATA_KEY_REGION to discover
|
|
@@ -1312,20 +1312,20 @@ export interface Media {
|
|
|
1312
1312
|
* @param index element to retrieve
|
|
1313
1313
|
* @returns the ISO-3166-1 of the region where the media was published (owned by @media).
|
|
1314
1314
|
*/
|
|
1315
|
-
get_region_data_nth(index: number): [ /* returnType */ string
|
|
1316
|
-
get_site(): string
|
|
1315
|
+
get_region_data_nth(index: number): [ /* returnType */ string, /* publication_date */ GLib.DateTime, /* certificate */ string ]
|
|
1316
|
+
get_site(): string
|
|
1317
1317
|
get_size(): number
|
|
1318
|
-
get_source(): string
|
|
1318
|
+
get_source(): string
|
|
1319
1319
|
get_start_time(): number
|
|
1320
|
-
get_studio(): string
|
|
1321
|
-
get_thumbnail(): string
|
|
1320
|
+
get_studio(): string
|
|
1321
|
+
get_thumbnail(): string
|
|
1322
1322
|
get_thumbnail_binary(size: number): number
|
|
1323
1323
|
get_thumbnail_binary_nth(size: number, index: number): number
|
|
1324
|
-
get_thumbnail_nth(index: number): string
|
|
1325
|
-
get_title(): string
|
|
1326
|
-
get_url(): string
|
|
1327
|
-
get_url_data(): [ /* returnType */ string
|
|
1328
|
-
get_url_data_nth(index: number): [ /* returnType */ string
|
|
1324
|
+
get_thumbnail_nth(index: number): string
|
|
1325
|
+
get_title(): string
|
|
1326
|
+
get_url(): string
|
|
1327
|
+
get_url_data(): [ /* returnType */ string, /* mime */ string | null ]
|
|
1328
|
+
get_url_data_nth(index: number): [ /* returnType */ string, /* mime */ string | null ]
|
|
1329
1329
|
/**
|
|
1330
1330
|
* Serializes a GrlMedia into a string. It does a basic serialization.
|
|
1331
1331
|
*
|
|
@@ -1337,7 +1337,7 @@ export interface Media {
|
|
|
1337
1337
|
* Set the media's author
|
|
1338
1338
|
* @param author the media's author
|
|
1339
1339
|
*/
|
|
1340
|
-
set_author(author: string
|
|
1340
|
+
set_author(author: string): void
|
|
1341
1341
|
/**
|
|
1342
1342
|
* Set the media's first age certification.
|
|
1343
1343
|
* This should usually be the media's most relevant
|
|
@@ -1345,7 +1345,7 @@ export interface Media {
|
|
|
1345
1345
|
* set other age certificates.
|
|
1346
1346
|
* @param certificate The age certificate of the media
|
|
1347
1347
|
*/
|
|
1348
|
-
set_certificate(certificate: string
|
|
1348
|
+
set_certificate(certificate: string): void
|
|
1349
1349
|
/**
|
|
1350
1350
|
* Set the creation_date of the media
|
|
1351
1351
|
* @param creation_date date when media was created
|
|
@@ -1355,7 +1355,7 @@ export interface Media {
|
|
|
1355
1355
|
* Set the media's description
|
|
1356
1356
|
* @param description the description
|
|
1357
1357
|
*/
|
|
1358
|
-
set_description(description: string
|
|
1358
|
+
set_description(description: string): void
|
|
1359
1359
|
/**
|
|
1360
1360
|
* Set the media's duration
|
|
1361
1361
|
* @param duration the duration in seconds
|
|
@@ -1365,12 +1365,12 @@ export interface Media {
|
|
|
1365
1365
|
* Set the location of a player for the media (usually a flash player)
|
|
1366
1366
|
* @param player location of an external player for this media
|
|
1367
1367
|
*/
|
|
1368
|
-
set_external_player(player: string
|
|
1368
|
+
set_external_player(player: string): void
|
|
1369
1369
|
/**
|
|
1370
1370
|
* Set an external location where users can play the media
|
|
1371
1371
|
* @param url external location where this media can be played.
|
|
1372
1372
|
*/
|
|
1373
|
-
set_external_url(url: string
|
|
1373
|
+
set_external_url(url: string): void
|
|
1374
1374
|
/**
|
|
1375
1375
|
* Set if the media is favourite or not
|
|
1376
1376
|
* @param favourite whether the item is favourite or not
|
|
@@ -1380,17 +1380,17 @@ export interface Media {
|
|
|
1380
1380
|
* Set the media identifier
|
|
1381
1381
|
* @param id the identifier of the media
|
|
1382
1382
|
*/
|
|
1383
|
-
set_id(id: string
|
|
1383
|
+
set_id(id: string): void
|
|
1384
1384
|
/**
|
|
1385
1385
|
* Sets the keyword describing the `media`.
|
|
1386
1386
|
* @param keyword a keyword describing the media
|
|
1387
1387
|
*/
|
|
1388
|
-
set_keyword(keyword: string
|
|
1388
|
+
set_keyword(keyword: string): void
|
|
1389
1389
|
/**
|
|
1390
1390
|
* Set the media last played date
|
|
1391
1391
|
* @param last_played date when the media was last played
|
|
1392
1392
|
*/
|
|
1393
|
-
set_last_played(last_played: string
|
|
1393
|
+
set_last_played(last_played: string): void
|
|
1394
1394
|
/**
|
|
1395
1395
|
* Set the media last played position
|
|
1396
1396
|
* @param last_position second at which the media playback was interrupted
|
|
@@ -1400,12 +1400,12 @@ export interface Media {
|
|
|
1400
1400
|
* Set the media license
|
|
1401
1401
|
* @param license The license of the media
|
|
1402
1402
|
*/
|
|
1403
|
-
set_license(license: string
|
|
1403
|
+
set_license(license: string): void
|
|
1404
1404
|
/**
|
|
1405
1405
|
* Set the media's mime-type
|
|
1406
1406
|
* @param mime the mime type
|
|
1407
1407
|
*/
|
|
1408
|
-
set_mime(mime: string
|
|
1408
|
+
set_mime(mime: string): void
|
|
1409
1409
|
/**
|
|
1410
1410
|
* Set the modification date of the media
|
|
1411
1411
|
* @param modification_date date when the media was last modified
|
|
@@ -1432,20 +1432,20 @@ export interface Media {
|
|
|
1432
1432
|
* Sets the `region` where `media` was published.
|
|
1433
1433
|
* @param region the region's ISO-3166-1 code
|
|
1434
1434
|
*/
|
|
1435
|
-
set_region(region: string
|
|
1435
|
+
set_region(region: string): void
|
|
1436
1436
|
/**
|
|
1437
1437
|
* Sets regional publication and certification information for `region`.
|
|
1438
1438
|
* @param region the region's ISO-3166-1 code
|
|
1439
1439
|
* @param publication_date the publication date
|
|
1440
1440
|
* @param certificate the age certification
|
|
1441
1441
|
*/
|
|
1442
|
-
set_region_data(region: string
|
|
1442
|
+
set_region_data(region: string, publication_date: GLib.DateTime, certificate: string): void
|
|
1443
1443
|
/**
|
|
1444
1444
|
* Set the media's site. A site is a website about the media such as a
|
|
1445
1445
|
* studio's promotional website for a movie.
|
|
1446
1446
|
* @param site the site
|
|
1447
1447
|
*/
|
|
1448
|
-
set_site(site: string
|
|
1448
|
+
set_site(site: string): void
|
|
1449
1449
|
/**
|
|
1450
1450
|
* Set the size of the media
|
|
1451
1451
|
* @param size the size in bytes
|
|
@@ -1455,17 +1455,17 @@ export interface Media {
|
|
|
1455
1455
|
* Set the media's source
|
|
1456
1456
|
* @param source the source
|
|
1457
1457
|
*/
|
|
1458
|
-
set_source(source: string
|
|
1458
|
+
set_source(source: string): void
|
|
1459
1459
|
/**
|
|
1460
1460
|
* Set the media studio
|
|
1461
1461
|
* @param studio The studio the media is from
|
|
1462
1462
|
*/
|
|
1463
|
-
set_studio(studio: string
|
|
1463
|
+
set_studio(studio: string): void
|
|
1464
1464
|
/**
|
|
1465
1465
|
* Set the media's thumbnail URL
|
|
1466
1466
|
* @param thumbnail the thumbnail URL
|
|
1467
1467
|
*/
|
|
1468
|
-
set_thumbnail(thumbnail: string
|
|
1468
|
+
set_thumbnail(thumbnail: string): void
|
|
1469
1469
|
/**
|
|
1470
1470
|
* Set the media's binary thumbnail
|
|
1471
1471
|
* @param thumbnail thumbnail buffer
|
|
@@ -1476,18 +1476,18 @@ export interface Media {
|
|
|
1476
1476
|
* Set the media's title
|
|
1477
1477
|
* @param title the title
|
|
1478
1478
|
*/
|
|
1479
|
-
set_title(title: string
|
|
1479
|
+
set_title(title: string): void
|
|
1480
1480
|
/**
|
|
1481
1481
|
* Set the media's URL
|
|
1482
1482
|
* @param url the media's URL
|
|
1483
1483
|
*/
|
|
1484
|
-
set_url(url: string
|
|
1484
|
+
set_url(url: string): void
|
|
1485
1485
|
/**
|
|
1486
1486
|
* Set the media's URL and its mime-type.
|
|
1487
1487
|
* @param url the media's URL
|
|
1488
1488
|
* @param mime the `url` mime type
|
|
1489
1489
|
*/
|
|
1490
|
-
set_url_data(url: string
|
|
1490
|
+
set_url_data(url: string, mime: string): void
|
|
1491
1491
|
|
|
1492
1492
|
// Class property signals of Grl-0.2.Grl.Media
|
|
1493
1493
|
|
|
@@ -1534,7 +1534,7 @@ export class Media extends Data {
|
|
|
1534
1534
|
* @param serial a serialized media
|
|
1535
1535
|
* @returns the GrlMedia from the serial
|
|
1536
1536
|
*/
|
|
1537
|
-
static unserialize(serial: string
|
|
1537
|
+
static unserialize(serial: string): Media
|
|
1538
1538
|
}
|
|
1539
1539
|
|
|
1540
1540
|
export module MediaAudio {
|
|
@@ -1558,22 +1558,22 @@ export interface MediaAudio {
|
|
|
1558
1558
|
* Adds a new artist to `audio`.
|
|
1559
1559
|
* @param artist an audio's artist
|
|
1560
1560
|
*/
|
|
1561
|
-
add_artist(artist: string
|
|
1561
|
+
add_artist(artist: string): void
|
|
1562
1562
|
/**
|
|
1563
1563
|
* Adds a new genre to `audio`.
|
|
1564
1564
|
* @param genre an audio's genre
|
|
1565
1565
|
*/
|
|
1566
|
-
add_genre(genre: string
|
|
1566
|
+
add_genre(genre: string): void
|
|
1567
1567
|
/**
|
|
1568
1568
|
* Adds a new lyrics to `audio`.
|
|
1569
1569
|
* @param lyrics an audio's lyrics
|
|
1570
1570
|
*/
|
|
1571
|
-
add_lyrics(lyrics: string
|
|
1571
|
+
add_lyrics(lyrics: string): void
|
|
1572
1572
|
/**
|
|
1573
1573
|
* Adds a new MusicBrainz artist id to `audio`.
|
|
1574
1574
|
* @param mb_artist_id a MusicBrainz artist identifier
|
|
1575
1575
|
*/
|
|
1576
|
-
add_mb_artist_id(mb_artist_id: string
|
|
1576
|
+
add_mb_artist_id(mb_artist_id: string): void
|
|
1577
1577
|
/**
|
|
1578
1578
|
* Sets all the keys related with the URL of a media resource and adds it to
|
|
1579
1579
|
* `audio` (useful for resources with more than one URL).
|
|
@@ -1581,7 +1581,7 @@ export interface MediaAudio {
|
|
|
1581
1581
|
* @param mime the `url` mime-type
|
|
1582
1582
|
* @param bitrate the `url` bitrate, or -1 to ignore
|
|
1583
1583
|
*/
|
|
1584
|
-
add_url_data(url: string
|
|
1584
|
+
add_url_data(url: string, mime: string, bitrate: number): void
|
|
1585
1585
|
|
|
1586
1586
|
// Overloads of add_url_data
|
|
1587
1587
|
|
|
@@ -1590,41 +1590,41 @@ export interface MediaAudio {
|
|
|
1590
1590
|
* @param url a media's URL
|
|
1591
1591
|
* @param mime th `url` mime type
|
|
1592
1592
|
*/
|
|
1593
|
-
add_url_data(url: string
|
|
1594
|
-
get_album(): string
|
|
1595
|
-
get_artist(): string
|
|
1596
|
-
get_artist_nth(index: number): string
|
|
1593
|
+
add_url_data(url: string, mime: string): void
|
|
1594
|
+
get_album(): string
|
|
1595
|
+
get_artist(): string
|
|
1596
|
+
get_artist_nth(index: number): string
|
|
1597
1597
|
get_bitrate(): number
|
|
1598
|
-
get_genre(): string
|
|
1599
|
-
get_genre_nth(index: number): string
|
|
1600
|
-
get_lyrics(): string
|
|
1601
|
-
get_lyrics_nth(index: number): string
|
|
1602
|
-
get_mb_album_id(): string
|
|
1603
|
-
get_mb_artist_id(): string
|
|
1604
|
-
get_mb_artist_id_nth(index: number): string
|
|
1605
|
-
get_mb_recording_id(): string
|
|
1606
|
-
get_mb_track_id(): string
|
|
1598
|
+
get_genre(): string
|
|
1599
|
+
get_genre_nth(index: number): string
|
|
1600
|
+
get_lyrics(): string
|
|
1601
|
+
get_lyrics_nth(index: number): string
|
|
1602
|
+
get_mb_album_id(): string
|
|
1603
|
+
get_mb_artist_id(): string
|
|
1604
|
+
get_mb_artist_id_nth(index: number): string
|
|
1605
|
+
get_mb_recording_id(): string
|
|
1606
|
+
get_mb_track_id(): string
|
|
1607
1607
|
get_track_number(): number
|
|
1608
|
-
get_url_data(): [ /* returnType */ string
|
|
1608
|
+
get_url_data(): [ /* returnType */ string, /* mime */ string | null, /* bitrate */ number ]
|
|
1609
1609
|
|
|
1610
1610
|
// Overloads of get_url_data
|
|
1611
1611
|
|
|
1612
|
-
get_url_data(): [ /* returnType */ string
|
|
1613
|
-
get_url_data_nth(index: number): [ /* returnType */ string
|
|
1612
|
+
get_url_data(): [ /* returnType */ string, /* mime */ string | null ]
|
|
1613
|
+
get_url_data_nth(index: number): [ /* returnType */ string, /* mime */ string | null, /* bitrate */ number ]
|
|
1614
1614
|
|
|
1615
1615
|
// Overloads of get_url_data_nth
|
|
1616
1616
|
|
|
1617
|
-
get_url_data_nth(index: number): [ /* returnType */ string
|
|
1617
|
+
get_url_data_nth(index: number): [ /* returnType */ string, /* mime */ string | null ]
|
|
1618
1618
|
/**
|
|
1619
1619
|
* Set the album of the audio
|
|
1620
1620
|
* @param album the audio's album
|
|
1621
1621
|
*/
|
|
1622
|
-
set_album(album: string
|
|
1622
|
+
set_album(album: string): void
|
|
1623
1623
|
/**
|
|
1624
1624
|
* Set the artist of the audio
|
|
1625
1625
|
* @param artist the audio's artist
|
|
1626
1626
|
*/
|
|
1627
|
-
set_artist(artist: string
|
|
1627
|
+
set_artist(artist: string): void
|
|
1628
1628
|
/**
|
|
1629
1629
|
* Set the bitrate of the audio
|
|
1630
1630
|
* @param bitrate the audio's bitrate
|
|
@@ -1634,32 +1634,32 @@ export interface MediaAudio {
|
|
|
1634
1634
|
* Set the genre of the audio
|
|
1635
1635
|
* @param genre the audio's genre
|
|
1636
1636
|
*/
|
|
1637
|
-
set_genre(genre: string
|
|
1637
|
+
set_genre(genre: string): void
|
|
1638
1638
|
/**
|
|
1639
1639
|
* Set the lyrics of the audio
|
|
1640
1640
|
* @param lyrics the audio's lyrics
|
|
1641
1641
|
*/
|
|
1642
|
-
set_lyrics(lyrics: string
|
|
1642
|
+
set_lyrics(lyrics: string): void
|
|
1643
1643
|
/**
|
|
1644
1644
|
* Set the MusicBrainz album identifier of the audio
|
|
1645
1645
|
* @param mb_album_id the MusicBrainz album identifier
|
|
1646
1646
|
*/
|
|
1647
|
-
set_mb_album_id(mb_album_id: string
|
|
1647
|
+
set_mb_album_id(mb_album_id: string): void
|
|
1648
1648
|
/**
|
|
1649
1649
|
* Set the MusicBrainz artist identifier of the audio
|
|
1650
1650
|
* @param mb_artist_id the MusicBrainz artist identifier
|
|
1651
1651
|
*/
|
|
1652
|
-
set_mb_artist_id(mb_artist_id: string
|
|
1652
|
+
set_mb_artist_id(mb_artist_id: string): void
|
|
1653
1653
|
/**
|
|
1654
1654
|
* Set the MusicBrainz recording identifier of the audio
|
|
1655
1655
|
* @param mb_recording_id the MusicBrainz recording identifier
|
|
1656
1656
|
*/
|
|
1657
|
-
set_mb_recording_id(mb_recording_id: string
|
|
1657
|
+
set_mb_recording_id(mb_recording_id: string): void
|
|
1658
1658
|
/**
|
|
1659
1659
|
* Set the MusicBrainz track identifier of the audio
|
|
1660
1660
|
* @param mb_track_id the MusicBrainz track identifier
|
|
1661
1661
|
*/
|
|
1662
|
-
set_mb_track_id(mb_track_id: string
|
|
1662
|
+
set_mb_track_id(mb_track_id: string): void
|
|
1663
1663
|
/**
|
|
1664
1664
|
* Set the track number of the audio
|
|
1665
1665
|
* @param track_number the audio's track number
|
|
@@ -1671,7 +1671,7 @@ export interface MediaAudio {
|
|
|
1671
1671
|
* @param mime the `url` mime-type
|
|
1672
1672
|
* @param bitrate the `url` bitrate, or -1 to ignore
|
|
1673
1673
|
*/
|
|
1674
|
-
set_url_data(url: string
|
|
1674
|
+
set_url_data(url: string, mime: string, bitrate: number): void
|
|
1675
1675
|
|
|
1676
1676
|
// Overloads of set_url_data
|
|
1677
1677
|
|
|
@@ -1680,7 +1680,7 @@ export interface MediaAudio {
|
|
|
1680
1680
|
* @param url the media's URL
|
|
1681
1681
|
* @param mime the `url` mime type
|
|
1682
1682
|
*/
|
|
1683
|
-
set_url_data(url: string
|
|
1683
|
+
set_url_data(url: string, mime: string): void
|
|
1684
1684
|
|
|
1685
1685
|
// Class property signals of Grl-0.2.Grl.MediaAudio
|
|
1686
1686
|
|
|
@@ -1832,7 +1832,7 @@ export interface MediaImage {
|
|
|
1832
1832
|
* @param width image width, or -1 to ignore
|
|
1833
1833
|
* @param height image height, or -1 to ignore
|
|
1834
1834
|
*/
|
|
1835
|
-
add_url_data(url: string
|
|
1835
|
+
add_url_data(url: string, mime: string, width: number, height: number): void
|
|
1836
1836
|
|
|
1837
1837
|
// Overloads of add_url_data
|
|
1838
1838
|
|
|
@@ -1841,27 +1841,27 @@ export interface MediaImage {
|
|
|
1841
1841
|
* @param url a media's URL
|
|
1842
1842
|
* @param mime th `url` mime type
|
|
1843
1843
|
*/
|
|
1844
|
-
add_url_data(url: string
|
|
1845
|
-
get_camera_model(): string
|
|
1844
|
+
add_url_data(url: string, mime: string): void
|
|
1845
|
+
get_camera_model(): string
|
|
1846
1846
|
get_exposure_time(): number
|
|
1847
|
-
get_flash_used(): string
|
|
1847
|
+
get_flash_used(): string
|
|
1848
1848
|
get_height(): number
|
|
1849
1849
|
get_iso_speed(): number
|
|
1850
1850
|
get_orientation(): number
|
|
1851
|
-
get_url_data(width: number, height: number): [ /* returnType */ string
|
|
1851
|
+
get_url_data(width: number, height: number): [ /* returnType */ string, /* mime */ string | null ]
|
|
1852
1852
|
|
|
1853
1853
|
// Overloads of get_url_data
|
|
1854
1854
|
|
|
1855
|
-
get_url_data(): [ /* returnType */ string
|
|
1856
|
-
get_url_data_nth(index: number, width: number, height: number): [ /* returnType */ string
|
|
1855
|
+
get_url_data(): [ /* returnType */ string, /* mime */ string | null ]
|
|
1856
|
+
get_url_data_nth(index: number, width: number, height: number): [ /* returnType */ string, /* mime */ string | null ]
|
|
1857
1857
|
|
|
1858
1858
|
// Overloads of get_url_data_nth
|
|
1859
1859
|
|
|
1860
|
-
get_url_data_nth(index: number): [ /* returnType */ string
|
|
1860
|
+
get_url_data_nth(index: number): [ /* returnType */ string, /* mime */ string | null ]
|
|
1861
1861
|
get_width(): number
|
|
1862
|
-
set_camera_model(camera_model: string
|
|
1862
|
+
set_camera_model(camera_model: string): void
|
|
1863
1863
|
set_exposure_time(exposure_time: number): void
|
|
1864
|
-
set_flash_used(flash_used: string
|
|
1864
|
+
set_flash_used(flash_used: string): void
|
|
1865
1865
|
/**
|
|
1866
1866
|
* Set the height of the image
|
|
1867
1867
|
* @param height the image's height
|
|
@@ -1898,7 +1898,7 @@ export interface MediaImage {
|
|
|
1898
1898
|
* @param width image width, or -1 to ignore
|
|
1899
1899
|
* @param height image height, or -1 to ignore
|
|
1900
1900
|
*/
|
|
1901
|
-
set_url_data(url: string
|
|
1901
|
+
set_url_data(url: string, mime: string, width: number, height: number): void
|
|
1902
1902
|
|
|
1903
1903
|
// Overloads of set_url_data
|
|
1904
1904
|
|
|
@@ -1907,7 +1907,7 @@ export interface MediaImage {
|
|
|
1907
1907
|
* @param url the media's URL
|
|
1908
1908
|
* @param mime the `url` mime type
|
|
1909
1909
|
*/
|
|
1910
|
-
set_url_data(url: string
|
|
1910
|
+
set_url_data(url: string, mime: string): void
|
|
1911
1911
|
/**
|
|
1912
1912
|
* Set the width of the image
|
|
1913
1913
|
* @param width the image's width
|
|
@@ -1983,17 +1983,17 @@ export interface MediaVideo {
|
|
|
1983
1983
|
* Adds the director of the movie.
|
|
1984
1984
|
* @param director director of the movie
|
|
1985
1985
|
*/
|
|
1986
|
-
add_director(director: string
|
|
1986
|
+
add_director(director: string): void
|
|
1987
1987
|
/**
|
|
1988
1988
|
* Adds the actor performing in the movie.
|
|
1989
1989
|
* @param performer an actor performing in the movie
|
|
1990
1990
|
*/
|
|
1991
|
-
add_performer(performer: string
|
|
1991
|
+
add_performer(performer: string): void
|
|
1992
1992
|
/**
|
|
1993
1993
|
* Adds the producer of the movie.
|
|
1994
1994
|
* @param producer producer of the movie
|
|
1995
1995
|
*/
|
|
1996
|
-
add_producer(producer: string
|
|
1996
|
+
add_producer(producer: string): void
|
|
1997
1997
|
/**
|
|
1998
1998
|
* Sets all the keys related with the URL of a media resource and adds it to
|
|
1999
1999
|
* `video` (useful for resources with more than one URL).
|
|
@@ -2003,7 +2003,7 @@ export interface MediaVideo {
|
|
|
2003
2003
|
* @param width video width, or -1 to ignore
|
|
2004
2004
|
* @param height video height, or -1 to ignore
|
|
2005
2005
|
*/
|
|
2006
|
-
add_url_data(url: string
|
|
2006
|
+
add_url_data(url: string, mime: string, framerate: number, width: number, height: number): void
|
|
2007
2007
|
|
|
2008
2008
|
// Overloads of add_url_data
|
|
2009
2009
|
|
|
@@ -2012,36 +2012,36 @@ export interface MediaVideo {
|
|
|
2012
2012
|
* @param url a media's URL
|
|
2013
2013
|
* @param mime th `url` mime type
|
|
2014
2014
|
*/
|
|
2015
|
-
add_url_data(url: string
|
|
2016
|
-
get_director(): string
|
|
2017
|
-
get_director_nth(index: number): string
|
|
2015
|
+
add_url_data(url: string, mime: string): void
|
|
2016
|
+
get_director(): string
|
|
2017
|
+
get_director_nth(index: number): string
|
|
2018
2018
|
get_episode(): number
|
|
2019
|
-
get_episode_title(): string
|
|
2019
|
+
get_episode_title(): string
|
|
2020
2020
|
get_framerate(): number
|
|
2021
2021
|
get_height(): number
|
|
2022
|
-
get_original_title(): string
|
|
2023
|
-
get_performer(): string
|
|
2024
|
-
get_performer_nth(index: number): string
|
|
2025
|
-
get_producer(): string
|
|
2026
|
-
get_producer_nth(index: number): string
|
|
2022
|
+
get_original_title(): string
|
|
2023
|
+
get_performer(): string
|
|
2024
|
+
get_performer_nth(index: number): string
|
|
2025
|
+
get_producer(): string
|
|
2026
|
+
get_producer_nth(index: number): string
|
|
2027
2027
|
get_season(): number
|
|
2028
|
-
get_show(): string
|
|
2029
|
-
get_url_data(framerate: number, width: number, height: number): [ /* returnType */ string
|
|
2028
|
+
get_show(): string
|
|
2029
|
+
get_url_data(framerate: number, width: number, height: number): [ /* returnType */ string, /* mime */ string | null ]
|
|
2030
2030
|
|
|
2031
2031
|
// Overloads of get_url_data
|
|
2032
2032
|
|
|
2033
|
-
get_url_data(): [ /* returnType */ string
|
|
2034
|
-
get_url_data_nth(index: number, framerate: number, width: number, height: number): [ /* returnType */ string
|
|
2033
|
+
get_url_data(): [ /* returnType */ string, /* mime */ string | null ]
|
|
2034
|
+
get_url_data_nth(index: number, framerate: number, width: number, height: number): [ /* returnType */ string, /* mime */ string | null ]
|
|
2035
2035
|
|
|
2036
2036
|
// Overloads of get_url_data_nth
|
|
2037
2037
|
|
|
2038
|
-
get_url_data_nth(index: number): [ /* returnType */ string
|
|
2038
|
+
get_url_data_nth(index: number): [ /* returnType */ string, /* mime */ string | null ]
|
|
2039
2039
|
get_width(): number
|
|
2040
2040
|
/**
|
|
2041
2041
|
* Sets the director of the movie.
|
|
2042
2042
|
* @param director director of the movie
|
|
2043
2043
|
*/
|
|
2044
|
-
set_director(director: string
|
|
2044
|
+
set_director(director: string): void
|
|
2045
2045
|
/**
|
|
2046
2046
|
* Sets the episode number of the video
|
|
2047
2047
|
* @param episode the video's episode
|
|
@@ -2051,7 +2051,7 @@ export interface MediaVideo {
|
|
|
2051
2051
|
* Sets the title of an episode
|
|
2052
2052
|
* @param episode_title the title of the episode
|
|
2053
2053
|
*/
|
|
2054
|
-
set_episode_title(episode_title: string
|
|
2054
|
+
set_episode_title(episode_title: string): void
|
|
2055
2055
|
/**
|
|
2056
2056
|
* Set the framerate of the video
|
|
2057
2057
|
* @param framerate the video's framerate
|
|
@@ -2066,17 +2066,17 @@ export interface MediaVideo {
|
|
|
2066
2066
|
* Sets the original, untranslated title of the movie.
|
|
2067
2067
|
* @param original_title original, untranslated title of the movie
|
|
2068
2068
|
*/
|
|
2069
|
-
set_original_title(original_title: string
|
|
2069
|
+
set_original_title(original_title: string): void
|
|
2070
2070
|
/**
|
|
2071
2071
|
* Sets the actor performing in the movie.
|
|
2072
2072
|
* @param performer an actor performing in the movie
|
|
2073
2073
|
*/
|
|
2074
|
-
set_performer(performer: string
|
|
2074
|
+
set_performer(performer: string): void
|
|
2075
2075
|
/**
|
|
2076
2076
|
* Sets the producer of the movie.
|
|
2077
2077
|
* @param producer producer of the movie
|
|
2078
2078
|
*/
|
|
2079
|
-
set_producer(producer: string
|
|
2079
|
+
set_producer(producer: string): void
|
|
2080
2080
|
/**
|
|
2081
2081
|
* Sets the season number of the video
|
|
2082
2082
|
* @param season the video's season
|
|
@@ -2086,7 +2086,7 @@ export interface MediaVideo {
|
|
|
2086
2086
|
* Sets the show title of the video
|
|
2087
2087
|
* @param show the video's show name
|
|
2088
2088
|
*/
|
|
2089
|
-
set_show(show: string
|
|
2089
|
+
set_show(show: string): void
|
|
2090
2090
|
/**
|
|
2091
2091
|
* Set the width and the height of the video
|
|
2092
2092
|
* @param width the video's width
|
|
@@ -2109,7 +2109,7 @@ export interface MediaVideo {
|
|
|
2109
2109
|
* @param width video width, or -1 to ignore
|
|
2110
2110
|
* @param height video height, or -1 to ignore
|
|
2111
2111
|
*/
|
|
2112
|
-
set_url_data(url: string
|
|
2112
|
+
set_url_data(url: string, mime: string, framerate: number, width: number, height: number): void
|
|
2113
2113
|
|
|
2114
2114
|
// Overloads of set_url_data
|
|
2115
2115
|
|
|
@@ -2118,7 +2118,7 @@ export interface MediaVideo {
|
|
|
2118
2118
|
* @param url the media's URL
|
|
2119
2119
|
* @param mime the `url` mime type
|
|
2120
2120
|
*/
|
|
2121
|
-
set_url_data(url: string
|
|
2121
|
+
set_url_data(url: string, mime: string): void
|
|
2122
2122
|
/**
|
|
2123
2123
|
* Set the width of the video
|
|
2124
2124
|
* @param width the video's width
|
|
@@ -2220,7 +2220,7 @@ export interface OperationOptions {
|
|
|
2220
2220
|
* @param key an operation option key
|
|
2221
2221
|
* @returns whether @key is set in @options.
|
|
2222
2222
|
*/
|
|
2223
|
-
key_is_set(key: string
|
|
2223
|
+
key_is_set(key: string): boolean
|
|
2224
2224
|
/**
|
|
2225
2225
|
* Check whether `options` obey to `caps`.
|
|
2226
2226
|
* Optionally provide the options that match (respectively don't match) `caps`
|
|
@@ -2351,28 +2351,28 @@ export interface Plugin {
|
|
|
2351
2351
|
* Get the author of the plugin
|
|
2352
2352
|
* @returns the author of the @plugin
|
|
2353
2353
|
*/
|
|
2354
|
-
get_author(): string
|
|
2354
|
+
get_author(): string
|
|
2355
2355
|
/**
|
|
2356
2356
|
* Get the description of the plugin
|
|
2357
2357
|
* @returns the description of the @plugin
|
|
2358
2358
|
*/
|
|
2359
|
-
get_description(): string
|
|
2359
|
+
get_description(): string
|
|
2360
2360
|
/**
|
|
2361
2361
|
* Get the filename containing the plugin
|
|
2362
2362
|
* @returns the filename containing @plugin
|
|
2363
2363
|
*/
|
|
2364
|
-
get_filename(): string
|
|
2364
|
+
get_filename(): string
|
|
2365
2365
|
/**
|
|
2366
2366
|
* Get the id of the plugin
|
|
2367
2367
|
* @returns the id of the @plugin
|
|
2368
2368
|
*/
|
|
2369
|
-
get_id(): string
|
|
2369
|
+
get_id(): string
|
|
2370
2370
|
/**
|
|
2371
2371
|
* Get the information of the `plugin` that is associated with the given key
|
|
2372
2372
|
* @param key a key representing information about this plugin
|
|
2373
2373
|
* @returns the information assigned to the given @key or NULL if there is no such information
|
|
2374
2374
|
*/
|
|
2375
|
-
get_info(key: string
|
|
2375
|
+
get_info(key: string): string
|
|
2376
2376
|
/**
|
|
2377
2377
|
* Returns a list of keys that can be queried to retrieve information about the
|
|
2378
2378
|
* plugin.
|
|
@@ -2383,17 +2383,17 @@ export interface Plugin {
|
|
|
2383
2383
|
* Get the license of the plugin
|
|
2384
2384
|
* @returns the license of the @plugin
|
|
2385
2385
|
*/
|
|
2386
|
-
get_license(): string
|
|
2386
|
+
get_license(): string
|
|
2387
2387
|
/**
|
|
2388
2388
|
* Get the name of the plugin
|
|
2389
2389
|
* @returns the name of the @plugin
|
|
2390
2390
|
*/
|
|
2391
|
-
get_name(): string
|
|
2391
|
+
get_name(): string
|
|
2392
2392
|
/**
|
|
2393
2393
|
* Get the site of the plugin
|
|
2394
2394
|
* @returns the site of the @plugin
|
|
2395
2395
|
*/
|
|
2396
|
-
get_site(): string
|
|
2396
|
+
get_site(): string
|
|
2397
2397
|
/**
|
|
2398
2398
|
* Gets the sources belonging to `plugin`.
|
|
2399
2399
|
* @returns a #GList of #GrlSource<!-- -->s. The content of the list should not be modified or freed. Use g_list_free() when done using the list.
|
|
@@ -2403,7 +2403,7 @@ export interface Plugin {
|
|
|
2403
2403
|
* Get the version of the plugin
|
|
2404
2404
|
* @returns the version of the @plugin
|
|
2405
2405
|
*/
|
|
2406
|
-
get_version(): string
|
|
2406
|
+
get_version(): string
|
|
2407
2407
|
/**
|
|
2408
2408
|
* Load the plugin
|
|
2409
2409
|
* @param configurations a list of configurations
|
|
@@ -2411,9 +2411,9 @@ export interface Plugin {
|
|
|
2411
2411
|
*/
|
|
2412
2412
|
load(configurations: Config[]): boolean
|
|
2413
2413
|
register_keys(): void
|
|
2414
|
-
set_filename(filename: string
|
|
2415
|
-
set_id(id: string
|
|
2416
|
-
set_info(key: string
|
|
2414
|
+
set_filename(filename: string): void
|
|
2415
|
+
set_id(id: string): void
|
|
2416
|
+
set_info(key: string, value: string): void
|
|
2417
2417
|
set_load_func(load_function: any | null): void
|
|
2418
2418
|
set_module(module: GModule.Module): void
|
|
2419
2419
|
set_optional_info(info: GLib.HashTable): void
|
|
@@ -2497,18 +2497,18 @@ export interface Registry {
|
|
|
2497
2497
|
* @param config_file a key-value file containing the configuration
|
|
2498
2498
|
* @returns %TRUE on success
|
|
2499
2499
|
*/
|
|
2500
|
-
add_config_from_file(config_file: string
|
|
2500
|
+
add_config_from_file(config_file: string): boolean
|
|
2501
2501
|
/**
|
|
2502
2502
|
* Load plugin configurations from a .ini-like resource file.
|
|
2503
2503
|
* @param resource_path a key-value file containing the configuration
|
|
2504
2504
|
* @returns %TRUE on success
|
|
2505
2505
|
*/
|
|
2506
|
-
add_config_from_resource(resource_path: string
|
|
2506
|
+
add_config_from_resource(resource_path: string): boolean
|
|
2507
2507
|
/**
|
|
2508
2508
|
* Set this path as part of default paths to load plugins.
|
|
2509
2509
|
* @param path a path with plugins
|
|
2510
2510
|
*/
|
|
2511
|
-
add_directory(path: string
|
|
2511
|
+
add_directory(path: string): void
|
|
2512
2512
|
/**
|
|
2513
2513
|
* Returns a list with all registered keys in system.
|
|
2514
2514
|
* @returns a #GList with all the available #GrlKeyID<!-- -->s. The content of the list should not be modified or freed. Use g_list_free() when done using the list.
|
|
@@ -2555,7 +2555,7 @@ export interface Registry {
|
|
|
2555
2555
|
* @param library_filename the path to the so file
|
|
2556
2556
|
* @returns %TRUE if the module is loaded correctly
|
|
2557
2557
|
*/
|
|
2558
|
-
load_plugin(library_filename: string
|
|
2558
|
+
load_plugin(library_filename: string): boolean
|
|
2559
2559
|
/**
|
|
2560
2560
|
* Loads plugin identified by `plugin_id`.
|
|
2561
2561
|
*
|
|
@@ -2565,32 +2565,32 @@ export interface Registry {
|
|
|
2565
2565
|
* @param plugin_id plugin identifier
|
|
2566
2566
|
* @returns %TRUE if the plugin is loaded correctly
|
|
2567
2567
|
*/
|
|
2568
|
-
load_plugin_by_id(plugin_id: string
|
|
2568
|
+
load_plugin_by_id(plugin_id: string): boolean
|
|
2569
2569
|
/**
|
|
2570
2570
|
* Loads a set of modules from directory in `path` which contains
|
|
2571
2571
|
* a group shared object files.
|
|
2572
2572
|
* @param path the path to the directory
|
|
2573
2573
|
* @returns %TRUE if the directory is valid.
|
|
2574
2574
|
*/
|
|
2575
|
-
load_plugin_directory(path: string
|
|
2575
|
+
load_plugin_directory(path: string): boolean
|
|
2576
2576
|
/**
|
|
2577
2577
|
* Look up for the metadata key with name `key_name`.
|
|
2578
2578
|
* @param key_name the key name
|
|
2579
2579
|
* @returns The metadata key, or GRL_METADATA_KEY_INVALID if not found
|
|
2580
2580
|
*/
|
|
2581
|
-
lookup_metadata_key(key_name: string
|
|
2581
|
+
lookup_metadata_key(key_name: string): KeyID
|
|
2582
2582
|
/**
|
|
2583
2583
|
* Returns `key` description.
|
|
2584
2584
|
* @param key a metadata key
|
|
2585
2585
|
* @returns metadata key description, or @NULL if not found
|
|
2586
2586
|
*/
|
|
2587
|
-
lookup_metadata_key_desc(key: KeyID): string
|
|
2587
|
+
lookup_metadata_key_desc(key: KeyID): string
|
|
2588
2588
|
/**
|
|
2589
2589
|
* Returns `key` name.
|
|
2590
2590
|
* @param key a metadata key
|
|
2591
2591
|
* @returns metadata key name, or @NULL if not found
|
|
2592
2592
|
*/
|
|
2593
|
-
lookup_metadata_key_name(key: KeyID): string
|
|
2593
|
+
lookup_metadata_key_name(key: KeyID): string
|
|
2594
2594
|
/**
|
|
2595
2595
|
* Look up the list of keys that have a relation with `key`.
|
|
2596
2596
|
*
|
|
@@ -2610,13 +2610,13 @@ export interface Registry {
|
|
|
2610
2610
|
* @param plugin_id the id of a plugin
|
|
2611
2611
|
* @returns The plugin found
|
|
2612
2612
|
*/
|
|
2613
|
-
lookup_plugin(plugin_id: string
|
|
2613
|
+
lookup_plugin(plugin_id: string): Plugin
|
|
2614
2614
|
/**
|
|
2615
2615
|
* This function will search and retrieve a source given its identifier.
|
|
2616
2616
|
* @param source_id the id of a source
|
|
2617
2617
|
* @returns The source found.
|
|
2618
2618
|
*/
|
|
2619
|
-
lookup_source(source_id: string
|
|
2619
|
+
lookup_source(source_id: string): Source
|
|
2620
2620
|
/**
|
|
2621
2621
|
* Validates `value` content complies with the key specification. That is, it has
|
|
2622
2622
|
* the expected type, and value are within the range specified in key (for
|
|
@@ -2662,7 +2662,7 @@ export interface Registry {
|
|
|
2662
2662
|
* @param plugin_id the identifier of the plugin
|
|
2663
2663
|
* @returns %TRUE% on success.
|
|
2664
2664
|
*/
|
|
2665
|
-
unload_plugin(plugin_id: string
|
|
2665
|
+
unload_plugin(plugin_id: string): boolean
|
|
2666
2666
|
/**
|
|
2667
2667
|
* Removes the `source` from the `registry` hash table
|
|
2668
2668
|
* @param source the source to unregister
|
|
@@ -2794,7 +2794,7 @@ export interface RelatedKeys {
|
|
|
2794
2794
|
* @param key key to use
|
|
2795
2795
|
* @returns string associated with @key, or %NULL in other case. Caller should not change nor free the value.
|
|
2796
2796
|
*/
|
|
2797
|
-
get_string(key: KeyID): string
|
|
2797
|
+
get_string(key: KeyID): string
|
|
2798
2798
|
/**
|
|
2799
2799
|
* Checks if `key` is in `relkeys`.
|
|
2800
2800
|
* @param key key to search
|
|
@@ -2866,7 +2866,7 @@ export interface RelatedKeys {
|
|
|
2866
2866
|
* @param key key to change or add
|
|
2867
2867
|
* @param strvalue the new value
|
|
2868
2868
|
*/
|
|
2869
|
-
set_string(key: KeyID, strvalue: string
|
|
2869
|
+
set_string(key: KeyID, strvalue: string): void
|
|
2870
2870
|
|
|
2871
2871
|
// Class property signals of Grl-0.2.Grl.RelatedKeys
|
|
2872
2872
|
|
|
@@ -3319,9 +3319,9 @@ export interface Source {
|
|
|
3319
3319
|
* @returns The capabilities
|
|
3320
3320
|
*/
|
|
3321
3321
|
get_caps(operation: SupportedOps): Caps
|
|
3322
|
-
get_description(): string
|
|
3322
|
+
get_description(): string
|
|
3323
3323
|
get_icon(): Gio.Icon
|
|
3324
|
-
get_id(): string
|
|
3324
|
+
get_id(): string
|
|
3325
3325
|
/**
|
|
3326
3326
|
* Creates an instance of #GrlMedia representing the media resource
|
|
3327
3327
|
* exposed at `uri`.
|
|
@@ -3336,7 +3336,7 @@ export interface Source {
|
|
|
3336
3336
|
* @param callback the user defined callback
|
|
3337
3337
|
* @returns the operation identifier
|
|
3338
3338
|
*/
|
|
3339
|
-
get_media_from_uri(uri: string
|
|
3339
|
+
get_media_from_uri(uri: string, keys: KeyID[], options: OperationOptions, callback: SourceResolveCb): number
|
|
3340
3340
|
/**
|
|
3341
3341
|
* Creates an instance of #GrlMedia representing the media resource
|
|
3342
3342
|
* exposed at `uri`.
|
|
@@ -3351,8 +3351,8 @@ export interface Source {
|
|
|
3351
3351
|
* @param options options wanted for that operation
|
|
3352
3352
|
* @returns a filled #GrlMedia
|
|
3353
3353
|
*/
|
|
3354
|
-
get_media_from_uri_sync(uri: string
|
|
3355
|
-
get_name(): string
|
|
3354
|
+
get_media_from_uri_sync(uri: string, keys: KeyID[], options: OperationOptions): Media
|
|
3355
|
+
get_name(): string
|
|
3356
3356
|
get_plugin(): Plugin
|
|
3357
3357
|
/**
|
|
3358
3358
|
* Gets the source rank
|
|
@@ -3445,7 +3445,7 @@ export interface Source {
|
|
|
3445
3445
|
* @param callback the user defined callback
|
|
3446
3446
|
* @returns the operation identifier
|
|
3447
3447
|
*/
|
|
3448
|
-
query(query: string
|
|
3448
|
+
query(query: string, keys: KeyID[], options: OperationOptions, callback: SourceResultCb): number
|
|
3449
3449
|
/**
|
|
3450
3450
|
* Execute a specialized query (specific for each provider) on a media
|
|
3451
3451
|
* repository.
|
|
@@ -3456,7 +3456,7 @@ export interface Source {
|
|
|
3456
3456
|
* @param options options wanted for that operation
|
|
3457
3457
|
* @returns a #GList with #GrlMedia elements. After use g_object_unref() every element and g_list_free() the list.
|
|
3458
3458
|
*/
|
|
3459
|
-
query_sync(query: string
|
|
3459
|
+
query_sync(query: string, keys: KeyID[], options: OperationOptions): Media[]
|
|
3460
3460
|
/**
|
|
3461
3461
|
* Remove a `media` from the `source` repository.
|
|
3462
3462
|
*
|
|
@@ -3510,7 +3510,7 @@ export interface Source {
|
|
|
3510
3510
|
* @param callback the user defined callback
|
|
3511
3511
|
* @returns the operation identifier
|
|
3512
3512
|
*/
|
|
3513
|
-
search(text: string
|
|
3513
|
+
search(text: string, keys: KeyID[], options: OperationOptions, callback: SourceResultCb): number
|
|
3514
3514
|
/**
|
|
3515
3515
|
* Search for the `text` string in a source for data identified with that string.
|
|
3516
3516
|
*
|
|
@@ -3525,7 +3525,7 @@ export interface Source {
|
|
|
3525
3525
|
* @param options options wanted for that operation
|
|
3526
3526
|
* @returns a #GList with #GrlMedia elements. After use g_object_unref() every element and g_list_free() the list.
|
|
3527
3527
|
*/
|
|
3528
|
-
search_sync(text: string
|
|
3528
|
+
search_sync(text: string, keys: KeyID[], options: OperationOptions): Media[]
|
|
3529
3529
|
/**
|
|
3530
3530
|
* Sets how much elements the source is able to handle in a single request.
|
|
3531
3531
|
*
|
|
@@ -3611,7 +3611,7 @@ export interface Source {
|
|
|
3611
3611
|
* @param uri A URI that can be used to identify a media resource
|
|
3612
3612
|
* @returns %TRUE if it can, %FALSE otherwise. This method is synchronous.
|
|
3613
3613
|
*/
|
|
3614
|
-
test_media_from_uri(uri: string
|
|
3614
|
+
test_media_from_uri(uri: string): boolean
|
|
3615
3615
|
/**
|
|
3616
3616
|
* Similar to grl_source_supported_keys(), but these keys
|
|
3617
3617
|
* are marked as writable, meaning the source allows the client
|
|
@@ -3694,7 +3694,7 @@ export interface Source {
|
|
|
3694
3694
|
* @param uri A URI that can be used to identify a media resource
|
|
3695
3695
|
* @returns %TRUE if it can, %FALSE otherwise. This method is synchronous.
|
|
3696
3696
|
*/
|
|
3697
|
-
vfunc_test_media_from_uri(uri: string
|
|
3697
|
+
vfunc_test_media_from_uri(uri: string): boolean
|
|
3698
3698
|
/**
|
|
3699
3699
|
* Similar to grl_source_supported_keys(), but these keys
|
|
3700
3700
|
* are marked as writable, meaning the source allows the client
|
|
@@ -4230,7 +4230,7 @@ export interface SourceClass {
|
|
|
4230
4230
|
get_caps: (source: Source, operation: SupportedOps) => Caps
|
|
4231
4231
|
resolve: (source: Source, ms: SourceResolveSpec) => void
|
|
4232
4232
|
may_resolve: (source: Source, media: Media, key_id: KeyID, missing_keys: KeyID[]) => boolean
|
|
4233
|
-
test_media_from_uri: (source: Source, uri: string
|
|
4233
|
+
test_media_from_uri: (source: Source, uri: string) => boolean
|
|
4234
4234
|
media_from_uri: (source: Source, mfus: SourceMediaFromUriSpec) => void
|
|
4235
4235
|
browse: (source: Source, bs: SourceBrowseSpec) => void
|
|
4236
4236
|
search: (source: Source, ss: SourceSearchSpec) => void
|