jellyfin.generated.api_10_11.LyricsApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| delete_lyrics | DELETE /Audio/{itemId}/Lyrics | Deletes an external lyric file. |
| download_remote_lyrics | POST /Audio/{itemId}/RemoteSearch/Lyrics/{lyricId} | Downloads a remote lyric. |
| get_lyrics | GET /Audio/{itemId}/Lyrics | Gets an item's lyrics. |
| get_remote_lyrics | GET /Providers/Lyrics/{lyricId} | Gets the remote lyrics. |
| search_remote_lyrics | GET /Audio/{itemId}/RemoteSearch/Lyrics | Search remote lyrics. |
| upload_lyrics | POST /Audio/{itemId}/Lyrics | Upload an external lyric file. |
delete_lyrics
delete_lyrics(item_id)
Deletes an external lyric file.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.LyricsApi(api_client)
item_id = 'item_id_example' # str | The item id.
try:
# Deletes an external lyric file.
api_instance.delete_lyrics(item_id)
except Exception as e:
print("Exception when calling LyricsApi->delete_lyrics: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| item_id | str | The item id. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | Lyric deleted. | - |
| 404 | Item not found. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
download_remote_lyrics
LyricDto download_remote_lyrics(item_id, lyric_id)
Downloads a remote lyric.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.lyric_dto import LyricDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.LyricsApi(api_client)
item_id = 'item_id_example' # str | The item id.
lyric_id = 'lyric_id_example' # str | The lyric id.
try:
# Downloads a remote lyric.
api_response = api_instance.download_remote_lyrics(item_id, lyric_id)
print("The response of LyricsApi->download_remote_lyrics:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling LyricsApi->download_remote_lyrics: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| item_id | str | The item id. | |
| lyric_id | str | The lyric id. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Lyric downloaded. | - |
| 404 | Item not found. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_lyrics
LyricDto get_lyrics(item_id)
Gets an item's lyrics.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.lyric_dto import LyricDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.LyricsApi(api_client)
item_id = 'item_id_example' # str | Item id.
try:
# Gets an item's lyrics.
api_response = api_instance.get_lyrics(item_id)
print("The response of LyricsApi->get_lyrics:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling LyricsApi->get_lyrics: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| item_id | str | Item id. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Lyrics returned. | - |
| 404 | Something went wrong. No Lyrics will be returned. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_remote_lyrics
LyricDto get_remote_lyrics(lyric_id)
Gets the remote lyrics.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.lyric_dto import LyricDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.LyricsApi(api_client)
lyric_id = 'lyric_id_example' # str | The remote provider item id.
try:
# Gets the remote lyrics.
api_response = api_instance.get_remote_lyrics(lyric_id)
print("The response of LyricsApi->get_remote_lyrics:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling LyricsApi->get_remote_lyrics: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| lyric_id | str | The remote provider item id. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | File returned. | - |
| 404 | Lyric not found. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
search_remote_lyrics
List[RemoteLyricInfoDto] search_remote_lyrics(item_id)
Search remote lyrics.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.remote_lyric_info_dto import RemoteLyricInfoDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.LyricsApi(api_client)
item_id = 'item_id_example' # str | The item id.
try:
# Search remote lyrics.
api_response = api_instance.search_remote_lyrics(item_id)
print("The response of LyricsApi->search_remote_lyrics:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling LyricsApi->search_remote_lyrics: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| item_id | str | The item id. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Lyrics retrieved. | - |
| 404 | Item not found. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
upload_lyrics
LyricDto upload_lyrics(item_id, file_name, body=body)
Upload an external lyric file.
Example
- Api Key Authentication (CustomAuthentication):
import jellyfin.generated.api_10_11
from jellyfin.generated.api_10_11 import ApiClient, Configuration
from jellyfin.generated.api_10_11.models.lyric_dto import LyricDto
from jellyfin.generated.api_10_11.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration(
host = "http://localhost"
)
# Configure API key authorization: CustomAuthentication
configuration.api_key['CustomAuthentication'] = f'Token="{os.getenv("API_KEY")}"'
configuration.api_key_prefix['CustomAuthentication'] = "MediaBrowser"
# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jellyfin.generated.api_10_11.LyricsApi(api_client)
item_id = 'item_id_example' # str | The item the lyric belongs to.
file_name = 'file_name_example' # str | Name of the file being uploaded.
body = None # bytearray | (optional)
try:
# Upload an external lyric file.
api_response = api_instance.upload_lyrics(item_id, file_name, body=body)
print("The response of LyricsApi->upload_lyrics:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling LyricsApi->upload_lyrics: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| item_id | str | The item the lyric belongs to. | |
| file_name | str | Name of the file being uploaded. | |
| body | bytearray | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: text/plain
- Accept: application/json, application/json; profile="CamelCase", application/json; profile="PascalCase", text/html
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Lyrics uploaded. | - |
| 400 | Error processing upload. | - |
| 404 | Item not found. | - |
| 503 | The server is currently starting or is temporarily not available. | * Retry-After - A hint for when to retry the operation in full seconds. * Message - A short plain-text reason why the server is not available. |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]