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