pyrekordbox.devicelib_plus.models#

class pyrekordbox.devicelib_plus.models.PlaylistType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: IntEnum

PLAYLIST = 0#

FOLDER = 1#

SMART_PLAYLIST = 4#

class pyrekordbox.devicelib_plus.models.FileType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: IntEnum

MP3 = 1#

M4A = 4#

FLAC = 5#

WAV = 11#

AIFF = 12#

AIF = 12#

class pyrekordbox.devicelib_plus.models.Base(**kwargs)[source]#

Bases: DeclarativeBase

Base class used to initialize the declarative base for all tables.

classmethod create(**kwargs)[source]#

classmethod columns()[source]#: Returns a list of all column names without the relationships.

classmethod relationships()[source]#: Returns a list of all relationship names.

classmethod keys()[source]#: Returns a list of all column names including the relationships.

values()[source]#: Returns a list of all column values including the relationships.

items()[source]#

to_dict()[source]#: Returns a dictionary of all column names and values.

pformat(indent=' ')[source]#

metadata = MetaData()#: Refers to the _schema.MetaData collection that will be used for new _schema.Table objects.

See also

orm_declarative_metadata

registry = <sqlalchemy.orm.decl_api.registry object>#: Refers to the _orm.registry in use where new _orm.Mapper objects will be associated.

class pyrekordbox.devicelib_plus.models.Album(**kwargs)[source]#

Bases: Base

Table for storing the album data of the Device Library Plus contents.

See also

Artist: Table for storing the artist data.

album_id#: The ID (primary key) of the table entry.

name#: The name of the album.

artist_id#: The artist_id of the Artist entry of the artist of this album.

image_id#: The image_id of the Image entry of the image of this album.

isComplation#: The compilation flag of the album.

nameForSearch#: The search string of the album.

artist#: The artist entry of the artist of this album (links to Artist).

artist_name#: The name of the album artist (Artist).

image#: The image of this album (links to Image).

image_path#: The path of the album Image (Image)

class pyrekordbox.devicelib_plus.models.Artist(**kwargs)[source]#

Bases: Base

Table for storing the artist data of the Device Library Plus contents.

artist_id#: The ID (primary key) of the table entry.

name#: The name of the artist.

nameForSearch#: The search string of the artist.

class pyrekordbox.devicelib_plus.models.Category(**kwargs)[source]#

Bases: Base

Table for storing the category data of the Device Library Plus contents.

category_id#: The ID (primary key) of the table entry.

menuItem_id#: The menuItem_id of the MenuItem entry of the menu item of the category.

sequenceNo#: The sequence number of the category used for sorting.

isVisible#: The visibility flag of the category.

menuItem#: The menu item of the category. (links to MenuItem).

menuItem_name#: The name of the menu item of the category. (MenuItem).

class pyrekordbox.devicelib_plus.models.Color(**kwargs)[source]#

Bases: Base

Table for storing the color data of the Device Library Plus contents.

color_id#: The ID (primary key) of the table entry.

name#: The name of the color.

class pyrekordbox.devicelib_plus.models.Content(**kwargs)[source]#

Bases: Base

Table for storing the content data of the Device Library Plus contents.

content_id#: The ID (primary key) of the table entry.

title#: The title of the track.

titleForSearch#: The search string of the track title.

subtitle#: The subtitle of the track.

bpmx100#: The BPM of the track multiplied by 100 (e.g. 120 BPM = 12000).

length#: The length of the track in milliseconds.

trackNo#: The track number of the track in the album.

discNo#: The disc number of the track in the album.

artist_id_artist#: The artist_id of the Artist entry of the artist of this track.

artist_id_remixer#: The artist_id of the Artist entry of the remixer of this track.

artist_id_originalArtist#: The artist_id of the Artist entry of the original artist of this track.

artist_id_composer#: The artist_id of the Artist entry of the composer of this track.

artist_id_lyricist#: The artist_id of the Artist entry of the lyricist of this track.

album_id#: The album_id of the Album entry of the album of this track.

genre_id#: The genre_id of the Genre entry of the genre of this track.

label_id#: The label_id of the Label entry of the label of this track.

key_id#: The key_id of the Key entry of the key of this track.

color_id#: The color_id of the Color entry of the color of this track.

image_id#: The image_id of the Image entry of the image of this track.

djComment#: The comment of the track.

rating#: The rating of the track (0-5).

releaseYear#: The release year of the track.

releaseDate#: The release date of the track.

dateCreated#: The date when the track was created.

dateAdded#: The date when the track was added to the library.

path#: The file path of the track.

fileName#: The file name of the track.

fileSize#: The file size of the trackin bytes.

fileType#: The file type of the track.

bitrate#: The bitrate of the track in kbps.

bitDepth#: The bit depth of the track.

samplingRate#: The sampling rate of the track in Hz.

isrc#: The ISRC (International Standard Recording Code) of the track.

isHotCueAutoLoadOn#: The hot cue auto load flag of the track.

isKuvoDeliverStatusOn#: The KUVO deliver status flag of the track.

kuvoDeliveryComment#: The KUVO deliver comment of the track.

masterDbId#: The ID of the track in the local master database.

masterContentId#: The content ID of the track in the local master database.

analysisDataFilePath#: The file path of the analysis files (ANLZ) of the track.

analysedBits#: The number of bits used for the analysis of the track.

contentLink#: The content linked flag of the track.

hasModified#: The modified flag of the track.

cueUpdateCount#: The number of times the cues of the track were updated.

analysisDataUpdateCount#: The number of times the analysis data of the track were updated.

informationUpdateCount#: The number of times the information of the track was updated.

artist#: The artist entry of the track (links to Artist).

remixer#: The remixer entry of the track (links to Artist).

originalArtist#: The original artist entry of the track (links to Artist).

composer#: The composer entry of the track (links to Artist).

lyricist#: The lyricist entry of the track (links to Artist).

album#: The album entry of the track (links to Album).

genre#: The genre entry of the track (links to Genre).

label#: The label entry of the track (links to Label).

key#: The key entry of the track (links to Key).

color#: The color entry of the track (links to Color).

image#: The image entry of the track (links to Image).

cues#: The cues of the track (links to Cue).

artist_name = ColumnAssociationProxyInstance(AssociationProxy('artist', 'name'))#: The name of the artist of the track (Artist).

remixer_name = ColumnAssociationProxyInstance(AssociationProxy('remixer', 'name'))#: The name of the remixer of the track (Artist).

original_artist_name = ColumnAssociationProxyInstance(AssociationProxy('originalArtist', 'name'))#: The name of the original artist of the track (Artist).

composer_name = ColumnAssociationProxyInstance(AssociationProxy('composer', 'name'))#: The name of the composer of the track (Artist).

lyricist_name = ColumnAssociationProxyInstance(AssociationProxy('lyricist', 'name'))#: The name of the lyricist of the track (Artist).

album_name = ColumnAssociationProxyInstance(AssociationProxy('album', 'name'))#: The name of the album of the track (Album).

genre_name = ColumnAssociationProxyInstance(AssociationProxy('genre', 'name'))#: The name of the genre of the track (Genre).

label_name = ColumnAssociationProxyInstance(AssociationProxy('label', 'name'))#: The name of the label of the track (Label).

image_path = ColumnAssociationProxyInstance(AssociationProxy('image', 'path'))#: The path of the image of the track (Image).

class pyrekordbox.devicelib_plus.models.Cue(**kwargs)[source]#

Bases: Base

Table for storing the cue data of the Device Library Plus contents.

cue_id#: The ID (primary key) of the table entry.

content_id#: The content_id of the Content entry of the content this cue belongs to.

kind#: The kind of the cue point (Cue=0, Fade-In=0, Fade-Out=0, Load=3, Loop=4).

colorTableIndex#: The index of the color in the color table.

cueComment#: The comment of the cue.

isActiveLoop#: The active loop flag of the cue.

beatLoopNumerator#: The numerator of the beat loop of the cue.

beatLoopDenominator#: The denominator of the beat loop of the cue.

inUsec#: The in point of the cue in microseconds.

outUsec#: The out point of the cue in microseconds.

in150FramePerSec#: The in point of the cue in 150 frames per second.

out150FramePerSec#: The out point of the cue in 150 frames per second.

inMpegFrameNumber#: The in point of the cue in MPEG frame number.

outMpegFrameNumber#: The out point of the cue in MPEG frame number.

inMpegAbs#: The absolute in point of the cue in MPEG frame number.

outMpegAbs#: The absolute out point of the cue in MPEG frame number.

inDecodingStartFramePosition#: The in point of the cue in decoding start frame position.

outDecodingStartFramePosition#: The out point of the cue in decoding start frame position.

inFileOffsetInBlock#: The in point of the cue in file offset in block.

outFileOffsetInBlock#: The out point of the cue in file offset in block.

inNumberOfSampleInBlock#: The in point of the cue in number of samples in block.

outNumberOfSampleInBlock#: The out point of the cue in number of samples in block.

content#: The content this cue belongs to (links to Content).

class pyrekordbox.devicelib_plus.models.Genre(**kwargs)[source]#

Bases: Base

Table for storing the genre data of the Device Library Plus contents.

genre_id#: The ID (primary key) of the table entry.

name#: The name of the genre.

class pyrekordbox.devicelib_plus.models.History(**kwargs)[source]#

Bases: Base

Table for storing the history data of the Device Library Plus contents.

history_id#: The ID (primary key) of the table entry.

sequenceNo#: The sequence number of the history entry used for sorting.

name#: The name of the history entry.

attribute#: The attribute of the history playlist.

history_id_parent#: The history_id of the parent History entry of this history entry.

parent#: !! processed by numpydoc !!

children#: The children of the history playlist (links to DjmdHistory). Backrefs to the parent history playlist via Parent.

songs#: The songs in the history playlist (links to HistoryContent).

contents = ObjectAssociationProxyInstance(AssociationProxy('songs', 'content'))#: The contents in the history playlist (links to Content).

class pyrekordbox.devicelib_plus.models.HistoryContent(**kwargs)[source]#

Bases: Base

Table for storing the history content data of the Device Library Plus contents.

history_id#: The history_id of the History entry of the history this content belongs to.

content_id#: The content_id of the Content entry of the content in this history.

sequenceNo#: The sequence number of the history content entry used for sorting.

history#: The history playlist this entry is in (links to History).

content#: The content entry of the song (links to Content).

class pyrekordbox.devicelib_plus.models.HotCueBankList(**kwargs)[source]#

Bases: Base

Table for storing the hot cue bank list data of the Device Library Plus contents.

parent#: !! processed by numpydoc !!

hotCueBankList_id#: The ID (primary key) of the table entry.

sequenceNo#: The sequence number of the hot cue bank list entry used for sorting.

name#: The name of the hot cue bank list.

image_id#: The image_id of the Image entry of the image of this hot cue bank list.

attribute#: The attribute of the hot cue bank list.

hotCueBankList_id_parent#: The hotCueBankList_id of the parent HotCueBankList entry.

image#: The image of this hot cue bank list (links to Image).

children#: The children of the hot cue bank list (links to HotCueBankList). Backrefs to the parent hot cue bank list via parent.

hotCueBankList_cues#: The cues in the hot cue bank list (links to HotCueBankListCue).

class pyrekordbox.devicelib_plus.models.HotCueBankListCue(**kwargs)[source]#

Bases: Base

Table for storing the hot cue bank list cue data of the Device Library Plus contents.

hotCueBankList_id#: The hotCueBankList_id of the HotCueBankList entry this cue belongs to.

cue_id#: The cue_id of the Cue entry of the cue in this hot cue bank list.

sequenceNo#: The sequence number of the hot cue bank list cue entry used for sorting.

hotCueBankList#: The hot cue bank list this entry is in (links to HotCueBankList).

cue#: The cue entry of the hot cue bank list (links to Cue).

class pyrekordbox.devicelib_plus.models.Image(**kwargs)[source]#

Bases: Base

Table for storing the image data of the Device Library Plus contents.

image_id#: The ID (primary key) of the table entry.

path#: The path of the image file.

class pyrekordbox.devicelib_plus.models.Key(**kwargs)[source]#

Bases: Base

Table for storing the key data of the Device Library Plus contents.

key_id#: The ID (primary key) of the table entry.

name#: The name of the key.

class pyrekordbox.devicelib_plus.models.Label(**kwargs)[source]#

Bases: Base

Table for storing the label data of the Device Library Plus contents.

label_id#: The ID (primary key) of the table entry.

name#: The name of the label.

class pyrekordbox.devicelib_plus.models.MenuItem(**kwargs)[source]#

Bases: Base

Table for storing the menu item data of the Device Library Plus contents.

menuItem_id#: The ID (primary key) of the table entry.

kind#: The kind of the menu item.

name#: The name of the menu item.

class pyrekordbox.devicelib_plus.models.MyTag(**kwargs)[source]#

Bases: Base

Table for storing the custom tag data of the Device Library Plus contents.

parent#: !! processed by numpydoc !!

myTag_id#: The ID (primary key) of the table entry.

sequenceNo#: The sequence number of the custom tag entry used for sorting.

name#: The name of the custom tag.

attribute#: The attribute of the custom tag.

myTag_id_parent#: !! processed by numpydoc !!

children#: The children of the custom tag (links to MyTag). Backrefs to the parent custom tag via parent.

myTags#: The my tag content in the custom tag (links to MyTagContent).

class pyrekordbox.devicelib_plus.models.MyTagContent(**kwargs)[source]#

Bases: Base

Table for storing the custom tag content data of the Device Library Plus contents.

myTag_id#: The myTag_id of the MyTag entry this content belongs to.

content_id#: The content_id of the Content entry of the content in this custom tag.

myTag#: The custom tag this entry is in (links to MyTag).

content#: The content entry of the custom tag (links to Content).

class pyrekordbox.devicelib_plus.models.Playlist(**kwargs)[source]#

Bases: Base

Table for storing the playlist data of the Device Library Plus contents.

parent#: !! processed by numpydoc !!

playlist_id#: The ID (primary key) of the table entry.

sequenceNo#: The sequence number of the playlist used for sorting.

name#: The name of the playlist.

image_id#: The image_id of the Image entry of the image of this playlist.

attribute#: The attribute of the playlist.

playlist_id_parent#: The playlist_id of the parent Playlist entry of this playlist.

children#: The children of the playlist (links to Playlist). Backrefs to the parent playlist via parent.

songs#: The songs in the playlist (links to PlaylistContent).

contents = ObjectAssociationProxyInstance(AssociationProxy('songs', 'content'))#: The contents in the playlist (links to Content).

class pyrekordbox.devicelib_plus.models.PlaylistContent(**kwargs)[source]#

Bases: Base

Table for storing the playlist content data of the Device Library Plus contents.

playlist_id#: The playlist_id of the Playlist entry this content belongs to.

content_id#: The content_id of the Content entry of the content in this playlist.

sequenceNo#: The sequence number of the playlist content entry used for sorting.

playlist#: The playlist this entry is in (links to Playlist).

content#: The content entry of the playlist (links to Content).

class pyrekordbox.devicelib_plus.models.Property(**kwargs)[source]#

Bases: Base

Table for storing the property data of the Device Library Plus contents.

deviceName#: The name of the device.

dbVersion#: The version of the database.

numberOfContents#: The number of contents in the database.

createdDate#: The date when the property was created.

backGroundColorType#: The background color type of the device.

myTagMasterDBID#: The master database ID of the custom tags.

class pyrekordbox.devicelib_plus.models.RecommendedLike(**kwargs)[source]#

Bases: Base

Table for storing the recommended like data of the Device Library Plus contents.

content_id_1#: The content_id of the first Content entry of the recommended like.

content_id_2#: The content_id of the second Content entry of the recommended like.

rating#: The rating of the recommended like (0-5).

createdDate#: The date when the recommended like was created.

content_1#: The first content of the recommended like (links to Content).

content_2#: The second content of the recommended like (links to Content).

class pyrekordbox.devicelib_plus.models.Sort(**kwargs)[source]#

Bases: Base

Table for storing the sort data for menu items of the Device Library Plus contents.

sort_id#: The ID (primary key) of the table entry.

menuItem_id#: The menuItem_id of the MenuItem entry of the menu item this sort belongs to.

sequenceNo#: The sequence number of the sort entry used for sorting.

isVisible#: The visibility flag of the sort entry.

isSelectedAsSubColumn#: The selected as sub-column flag of the sort entry.

menuItem#: The menu item of the sort entry (links to MenuItem).