MythTV  master
Functions | Variables
musicbrainzngs.caa Namespace Reference

Functions

def set_caa_hostname (new_hostname)
 
def _caa_request (mbid, imageid=None, size=None, entitytype="release")
 
def get_image_list (releaseid)
 
def get_release_group_image_list (releasegroupid)
 
def get_release_group_image_front (releasegroupid, size=None)
 
def get_image_front (releaseid, size=None)
 
def get_image_back (releaseid, size=None)
 
def get_image (mbid, coverid, size=None, entitytype="release")
 

Variables

list __all__
 
string hostname = "coverartarchive.org"
 

Function Documentation

◆ set_caa_hostname()

def musicbrainzngs.caa.set_caa_hostname (   new_hostname)
Set the base hostname for Cover Art Archive requests.
Defaults to 'coverartarchive.org'.

Definition at line 20 of file caa.py.

◆ _caa_request()

def musicbrainzngs.caa._caa_request (   mbid,
  imageid = None,
  size = None,
  entitytype = "release" 
)
private
Make a CAA request.

:param imageid: ``front``, ``back`` or a number from the listing obtained
                with :meth:`get_image_list`.
:type imageid: str

:param size: 250, 500
:type size: str or None

:param entitytype: ``release`` or ``release-group``
:type entitytype: str

Definition at line 27 of file caa.py.

Referenced by musicbrainzngs.caa.get_image(), musicbrainzngs.caa.get_image_list(), and musicbrainzngs.caa.get_release_group_image_list().

◆ get_image_list()

def musicbrainzngs.caa.get_image_list (   releaseid)
Get the list of cover art associated with a release.

The return value is the deserialized response of the `JSON listing
<http://musicbrainz.org/doc/Cover_Art_Archive/API#.2Frelease.2F.7Bmbid.7D.2F>`_
returned by the Cover Art Archive API.

If an error occurs then a :class:`~musicbrainzngs.ResponseError` will
be raised with one of the following HTTP codes:

* 400: `Releaseid` is not a valid UUID
* 404: No release exists with an MBID of `releaseid`
* 503: Ratelimit exceeded

Definition at line 84 of file caa.py.

◆ get_release_group_image_list()

def musicbrainzngs.caa.get_release_group_image_list (   releasegroupid)
Get the list of cover art associated with a release group.

The return value is the deserialized response of the `JSON listing
<http://musicbrainz.org/doc/Cover_Art_Archive/API#.2Frelease-group.2F.7Bmbid.7D.2F>`_
returned by the Cover Art Archive API.

If an error occurs then a :class:`~musicbrainzngs.ResponseError` will
be raised with one of the following HTTP codes:

* 400: `Releaseid` is not a valid UUID
* 404: No release exists with an MBID of `releaseid`
* 503: Ratelimit exceeded

Definition at line 101 of file caa.py.

◆ get_release_group_image_front()

def musicbrainzngs.caa.get_release_group_image_front (   releasegroupid,
  size = None 
)
Download the front cover art for a release group.
The `size` argument and the possible error conditions are the same as for
:meth:`get_image`.

Definition at line 118 of file caa.py.

◆ get_image_front()

def musicbrainzngs.caa.get_image_front (   releaseid,
  size = None 
)
Download the front cover art for a release.
The `size` argument and the possible error conditions are the same as for
:meth:`get_image`.

Definition at line 127 of file caa.py.

◆ get_image_back()

def musicbrainzngs.caa.get_image_back (   releaseid,
  size = None 
)
Download the back cover art for a release.
The `size` argument and the possible error conditions are the same as for
:meth:`get_image`.

Definition at line 135 of file caa.py.

◆ get_image()

def musicbrainzngs.caa.get_image (   mbid,
  coverid,
  size = None,
  entitytype = "release" 
)
Download cover art for a release. The coverart file to download
is specified by the `coverid` argument.

If `size` is not specified, download the largest copy present, which can be
very large.

If an error occurs then a :class:`~musicbrainzngs.ResponseError`
will be raised with one of the following HTTP codes:

* 400: `Releaseid` is not a valid UUID or `coverid` is invalid
* 404: No release exists with an MBID of `releaseid`
* 503: Ratelimit exceeded

:param coverid: ``front``, ``back`` or a number from the listing obtained with
                :meth:`get_image_list`
:type coverid: int or str

:param size: 250, 500 or None. If it is None, the largest available picture
             will be downloaded. If the image originally uploaded to the
             Cover Art Archive was smaller than the requested size, only
             the original image will be returned.
:type size: str or None

:param entitytype: The type of entity for which to download the cover art.
                   This is either ``release`` or ``release-group``.
:type entitytype: str
:return: The binary image data
:type: str

Definition at line 143 of file caa.py.

Referenced by musicbrainzngs.caa.get_image_back(), musicbrainzngs.caa.get_image_front(), and musicbrainzngs.caa.get_release_group_image_front().

Variable Documentation

◆ __all__

list musicbrainzngs.caa.__all__
private
Initial value:
1 = [
2  'set_caa_hostname', 'get_image_list', 'get_release_group_image_list',
3  'get_release_group_image_front', 'get_image_front', 'get_image_back',
4  'get_image'
5  ]

Definition at line 6 of file caa.py.

◆ hostname

string musicbrainzngs.caa.hostname = "coverartarchive.org"

Definition at line 17 of file caa.py.

Referenced by MythCoreContext.ConnectCommandSocket(), MythCoreContext.ConnectEventSocket(), VideoDisplayProfile.CreateProfileGroup(), VideoDisplayProfile.CreateProfiles(), HouseKeeper.customEvent(), VideoDisplayProfile.DeleteProfileGroup(), VideoDisplayProfile.DeleteProfiles(), OutboundRequestHandler.DoConnectToMaster(), doUpgradeTVDatabaseSchema(), Scheduler.FillRecordingDir(), ProfileGroup.fillSelections(), HttpStatus.FillStatusXML(), StorageGroup.FindDirs(), MainServer.GetActiveBackends(), RTCPDataPacket.GetData(), VideoDisplayProfile.GetDefaultProfileName(), RemoteFile.GetFileHash(), HTTPRequest.GetHostName(), CardUtil.GetInputIDs(), MainServer.GetMediaServerByHostname(), MusicPlayer.getNotificationID(), VideoDisplayProfile.GetProfileGroupID(), VideoDisplayProfile.GetProfiles(), Myth.GetSetting(), GetSettingsMap(), MainServer.GetSlaveByHostname(), CardUtil.GetVideoDevices(), MainServer.HandleAddChildInput(), BaseRequestHandler.HandleAnnounce(), FileServerHandler.HandleAnnounce(), MainServer.HandleMusicCalcTrackLen(), MainServer.HandleMusicFindAlbumArt(), MainServer.HandleMusicFindLyrics(), MainServer.HandleMusicSaveLyrics(), MainServer.HandleMusicTagAddImage(), MainServer.HandleMusicTagChangeImage(), MainServer.HandleMusicTagGetImage(), MainServer.HandleMusicTagRemoveImage(), MainServer.HandleMusicTagUpdateMetadata(), MainServer.HandleMusicTagUpdateVolatile(), FileServerHandler.HandleQueryFileHash(), MainServer.HandleQueryFileHash(), MainServer.HandleQueryFindFile(), MainServer.HandleQueryRecordings(), MainServer.HandleScanMusic(), MainServer.HandleSetSetting(), MainServer.HandleSettingQuery(), StorageGroup.Init(), JobQueue.InJobRunWindow(), CardUtil.IsInputTypePresent(), CardUtil.IsTunerShared(), load_settings(), MythControls.LoadData(), MythContextPrivate.LoadDatabaseSettings(), LoadFromRecorded(), main(), RemoteFile.openSocket(), NetworkControl.processPlay(), JobQueue.ProcessQueue(), QueueTranscodeJob(), JobQueue.RecoverQueue(), RemoteGetExistingRecorder(), MythCoreContext.SendHostSystemEvent(), VideoDisplayProfile.SetDefaultProfileName(), FileSystemInfo.setHostname(), MythCoreContext.SetLocalHostname(), transUnlink(), VideoDisplayProfile.VideoDisplayProfile(), and WasAutomaticStart().