Articles

Mypleks pleksapi.

by admin

klasse plexapi.myplex.MyPlexAccount(brugernavn=Ingen, adgangskode=Ingen, token=Ingen, session=ingen, timeout=ingen) kur

baser: plexapi.base.PlexObject

mypleks konto-og profiloplysninger. Dette objekt repræsenterer dataene fundet konto på myplex.tv servere ved url ‘en https://plex.tv/users/account. Du kan oprette dette objektdirekte ved at indtaste dit brugernavn & adgangskode (eller token). Der er også en bekvemmelighedmetode leveret på myPlexAccount() som vil skabeog returnere dette objekt.

parametre

  • brugernavn (str) – dit brugernavn.

  • adgangskode (str) – din adgangskode.

  • session (anmodninger.Session, valgfri) – brug dit eget sessionsobjekt, hvis du vilcache http-svarene fra PMS

  • timeout (int) – timeout i sekunder ved første forbindelse til mypleks (standardkonfiguration.TIMEOUT).

variabler

  • SIGNIN (str) – ‘https://plex.tv/users/sign_in.xml’

  • nøgle (str) – ‘https://plex.tv/users/account’

  • authenticationToken (str) – ukendt.

  • certificateVersion (str) – ukendt.

  • cloudSyncDevice (str) – ukendt.

  • e – mail (str) – din nuværende e-mail-adresse.

  • rettigheder (liste<str>) – liste over enheder, du har lov til at bruge med denne konto.

  • gæst (bool) – ukendt.

  • hjem (bool) – ukendt.

  • hjemstørrelse (int) – ukendt.

  • id (int) – din konto-id.

  • lokalitet (str) – din lokalitet

  • mailing_list_status (str) – din aktuelle postlistestatus.

  • maks.størrelse (int) – ukendt.

  • køemail (str) – e-mail-adresse for at tilføje elementer til dit ur senere kø.

  • kø (str) – ukendt.

  • begrænset (bool) – ukendt.

  • roller – (liste<str>) Lit af konto roller. Plekspass medlemskab opført her.

  • scrobbleTypes (str) – Description

  • secure (bool) – Description

  • subsctiptionactive (bool) – True hvis din subsctiption er aktiv.

  • subscriptionFeatures – (liste<str>) liste over funktioner tilladt på dit abonnement.

  • abonnementsplan (str) – navn på abonnementsplan.

  • subscriptionStatus (str) – String repræsentation af subscriptionActive.

  • tommelfinger (str) – URL til din kontominiaturebillede.

  • Titel (str) – ukendt. – Ligner et alias for brugernavn.

  • brugernavn (str) – din konto brugernavn.

  • uuid (str) – ukendt.

  • _token (str) – Token bruges til at få adgang til denne klient.

  • _session (obj) – anmoder session objekt bruges til at få adgang til denne klient.

device(name=None, clientId=None)

returnererMyPlexDevice der matcher det angivne navn.

parametre

  • navn (str) – navn at matche imod.

  • clientId (str) – clientIdentifier at matche imod.

devices() liter

returnerer en liste over alleMyPlexDevice objekter, der er forbundet til serveren.

resource

(navn) venstre

returnererMyPlexResource der matcher det angivne navn.

parametre

navn (str) – navn at matche imod.

resources() list

returnerer en liste over alleMyPlexResource objekter, der er forbundet til serveren.

inviteFriend(bruger, server, sektioner=ingen, tilladsync=falsk, tilladkameraupload=falsk, tilladkanaler=falsk, filterMovies=ingen, filterTelevision=ingen, filterMusic=ingen). parametre

  • bruger (MyPlexUser) – Mypleksuserobjekt, Brugernavn eller emailaf brugeren, der skal tilføjes.

  • server (PlexServer) – Plekserverobjekt eller machineidentifierindeholder bibliotekssektionerne, der skal deles.

  • sektioner (liste<LibrarySection>) – liste over Biblioteksektionsobjekter eller navneat blive delt (standard ingen). sektioner skal defineres for at opdatere delte biblioteker.

  • tilladsync (Bool) – Indstil sand for at tillade brugeren at synkronisere indhold.

  • tilladcameraupload (Bool) – Indstil sand for at tillade brugeren at uploade fotos.

  • tillad kanaler (Bool) – Indstil sand for at give brugeren mulighed for at bruge installerede kanaler.

  • filterMovies (Dict) – Dict indeholdende nøgle ‘contentRating’ og / eller ‘label’ hvert sæt til en liste over værdier, der skal filtreres. eks: {‘contentRating’:, ‘label’:}

  • filterTelevision (Dict) – Dict indeholdende nøgle ‘contentRating’ og/eller ‘label’ hvert sæt til en liste over værdier, der skal filtreres. eks: {‘contentRating’:, ‘label’:}

  • filterMusic (Dict) – Dict indeholdende nøgle ‘label’ indstillet til en liste over værdier, der skal filtreres.eks: {‘etiket’:}

createHomeUser(bruger, server, sektioner=ingen, tilladsync=False, tilladkameraupload=False, tilladkanaler=False, filterMovies=None, filterTelevision=None, filterMusic=None). parametre

  • bruger (MyPlexUser) – Mypleksuserobjekt, Brugernavn eller emailaf brugeren, der skal tilføjes.

  • server (PlexServer) – Plekserverobjekt eller machineidentifierindeholder bibliotekssektionerne, der skal deles.

  • sektioner (liste<LibrarySection>) – liste over Biblioteksektionsobjekter eller navneat blive delt (standard ingen). sektioner skal defineres for at opdatere delte biblioteker.

  • tilladsync (Bool) – Indstil sand for at tillade brugeren at synkronisere indhold.

  • tilladcameraupload (Bool) – Indstil sand for at tillade brugeren at uploade fotos.

  • tillad kanaler (Bool) – Indstil sand for at give brugeren mulighed for at bruge installerede kanaler.

  • filterMovies (Dict) – Dict indeholdende nøgle ‘contentRating’ og / eller ‘label’ hvert sæt til en liste over værdier, der skal filtreres. eks: {‘contentRating’:, ‘label’:}

  • filterTelevision (Dict) – Dict indeholdende nøgle ‘contentRating’ og/eller ‘label’ hvert sæt til en liste over værdier, der skal filtreres. eks: {‘contentRating’:, ‘label’:}

  • filterMusic (Dict) – Dict indeholdende nøgle ‘label’ indstillet til en liste over værdier, der skal filtreres.eks: {‘etiket’:}

createExistingUser(bruger, server, sektioner=ingen, tilladsync=False, tilladkameraupload=False, tilladkanaler=False, filterMovies=None, filterTelevision=None, filterMusic=None). parametre

  • bruger (MyPlexUser) – Mypleksuserobjekt, Brugernavn eller emailaf brugeren, der skal tilføjes.

  • server (PlexServer) – Plekserverobjekt eller machineidentifierindeholder bibliotekssektionerne, der skal deles.

  • sektioner (liste<LibrarySection>) – liste over Biblioteksektionsobjekter eller navneat blive delt (standard ingen). sektioner skal defineres for at opdatere delte biblioteker.

  • tilladsync (Bool) – Indstil sand for at tillade brugeren at synkronisere indhold.

  • tilladcameraupload (Bool) – Indstil sand for at tillade brugeren at uploade fotos.

  • tillad kanaler (Bool) – Indstil sand for at give brugeren mulighed for at bruge installerede kanaler.

  • filterMovies (Dict) – Dict indeholdende nøgle ‘contentRating’ og / eller ‘label’ hvert sæt til en liste over værdier, der skal filtreres. eks: {‘contentRating’:, ‘label’:}

  • filterTelevision (Dict) – Dict indeholdende nøgle ‘contentRating’ og/eller ‘label’ hvert sæt til en liste over værdier, der skal filtreres. eks: {‘contentRating’:, ‘label’:}

  • filterMusic (Dict) – Dict indeholdende nøgle ‘label’ indstillet til en liste over værdier, der skal filtreres.eks: {‘label’:}

removeFriend(bruger) venstre

fjern den angivne bruger fra Al deling.

parametre

bruger – str) – mypleksuser, brugernavn, e-mail for den bruger, der skal tilføjes.

removeHomeUser(bruger) ret

fjern den angivne administrerede bruger hjemmefra.

parametre

bruger – str) – mypleksuser, brugernavn, e-mail af brugeren, der skal fjernes fra hjemmet.

updateFriend(bruger, server, sektioner=ingen, removeSections=False, tilladsync=ingen, tilladcameraupload=ingen, tilladkanaler=ingen, filterMovies=ingen, filterTelevision=ingen, filterMusic=ingen). parametre

  • bruger (MyPlexUser) – Mypleksuserobjekt, Brugernavn eller emailaf brugeren, der skal opdateres.

  • server (PlexServer) – Plekserverobjekt eller machineidentifierindeholder bibliotekssektionerne, der skal deles.

  • sektioner (liste<LibrarySection>) – liste over Biblioteksektionsobjekter eller navneat blive delt (standard ingen). sektioner skal defineres for at opdatere delte biblioteker.

  • removeSections (Bool) – Indstil True for at fjerne alle aktier. Erstatter sektioner.

  • tilladsync (Bool) – Indstil sand for at tillade brugeren at synkronisere indhold.

  • tilladcameraupload (Bool) – Indstil sand for at tillade brugeren at uploade fotos.

  • tillad kanaler (Bool) – Indstil sand for at give brugeren mulighed for at bruge installerede kanaler.

  • filterMovies (Dict) – Dict indeholdende nøgle ‘contentRating’ og / eller ‘label’ hvert sæt til en liste over værdier, der skal filtreres. eks: {‘indholdsfortegnelse’:, ‘etiket’:}

  • filterTelevision (Dict) – Dict indeholdende nøgle ‘contentRating’ og / eller ‘label’ hvert sæt til en liste over værdier, der skal filtreres. eks: {‘contentRating’:, ‘label’:}

  • filterMusic (Dict) – Dict indeholdende nøgle ‘label’ indstillet til en liste over værdier, der skal filtreres.eks: {‘label’:}

user(brugernavn) liter

returnerer MyPlexUser der matcher den angivne e-mail eller brugernavn.

parametre

brugernavn – str) – Brugernavn, E-mail eller ID for brugeren, der skal returneres.

users() list

returnerer en liste over alleMyPlexUser objekter, der er forbundet til din konto.Dette inkluderer både venner og ventende invitationer. Du kan henvise til brugeren.ven til at skelne mellem de to.

optOut(afspilning=Ingen, bibliotek=ingen).Se: https://www.plex.tv/about/privacy-legal/syncItems(client=None, clientId=None) venstre

returnerer en forekomst af SyncList for specificeret klient.

parametre

  • klient (MyPlexDevice) – en klient til forespørgsel SyncItems for.

  • clientId (str) – en identifikator for en klient til forespørgsel SyncItems for.

Hvis både klient og clientId forudsat at klienten foretrækkes.Hvis hverken klient eller clientId forudsat clientId ville blive indstillet til aktuelle klienters identifikator.

sync(sync_item, client=None, clientId=None). Det er altid nemmere at bruge metoder defineret direkte i medieobjekterne, f. eks.sync()sync(). parametre

  • klient (MyPlexDevice) – en klient, som du skal tilføje SyncItem til.

  • clientId (str) – en identifikator for en klient, som du skal tilføje SyncItem til.

  • sync_item (SyncItem) – forberedt Syncitemobjekt med alle felter indstillet.

Hvis både klient og clientId forudsat at klienten foretrækkes.Hvis hverken klient eller clientId forudsat clientId ville blive indstillet til aktuelle klienters identifikator.

returnerer

en forekomst af Oprettet syncItem.

returtype

SyncItem

hæver

  • Badanmodning – når klient med leveret clientId ikke blev fundet.

  • dårlig anmodning – forudsat klient giver ikke sync-target.

claimToken().Se: https://hub.docker.com/r/plexinc/pms-docker/https://www.plex.tv/claim/history(maksresultater=9999999, mindate=None).: param maksresultater: kun returnere det angivne antal resultater (valgfrit).: skriv maks. resultater: int: param mindate: Min datetime at returnere resultater fra.: type mindate: datetimevideoOnDemand()¶

Returns a list of VOD Hub items Hub

webShows()¶

Returns a list of Webshow Hub items Hub

news()¶

Returns a list of News Hub items Hub

podcasts()¶

Returns a list of Podcasts Hub items Hub

tidal()¶

Returns a list of tidal Hub items Hub

link(pin)¶

Link a device to the account using a pin kode.

parametre

pin (str) – den 4-cifrede link-pin-kode.

classplexapi.myplex.MyPlexUser(server, data, initpath=None, parent=None)

baser: plexapi.base.PlexObject

dette objekt repræsenterer ikke-loggede brugere som venner og linkedaccounts. BEMÆRK: Dette bør ikke forveksles med MyPlexAccountsom er din specifikke konto. Den rå HML for de data, der præsenteres her, kan findes på: https://plex.tv/api/users/

variabler

  • TAG (str) – ‘bruger’

  • nøgle (str) – ‘https://plex.tv/api/users/’

  • tillad kameraupload (bool) – sandt, hvis denne bruger kan uploade billeder.

  • tillad kanaler (bool) – sandt, hvis denne bruger har adgang til kanaler.

  • tilladsync (bool) – sandt, hvis denne bruger kan synkronisere.

  • e – mail (str) – brugerens e-mail-adresse ([email protected]).

  • filterAll (str) – ukendt.

  • filterMovies (str) – ukendt.

  • filterMusic (str) – ukendt.

  • filterPhotos (str) – ukendt.

  • filterTelevision (str) – ukendt.

  • hjem (bool) – ukendt.

  • id (int) – brugerens konto-id.

  • beskyttet (falsk) – ukendt (muligvis SSL aktiveret?).

  • anbefalingerplaylitid (str) – ukendt.

  • begrænset (str) – ukendt.

  • tommelfinger (str) – Link til brugerens avatar.

  • Titel (str) – synes at være en aliad for brugernavn.

  • brugernavn (str) – brugerens brugernavn.

  • servere-servere, der deles mellem bruger og ven

server(navn) Lars

returnerer MyPlexServerShare, der matcher det angivne navn.

parametre

navn (str) – navnet på den server, der skal returneres.

history(maksresultater=9999999, mindate=ingen).: param maksresultater: kun returnere det angivne antal resultater (valgfrit).: skriv maks. resultater: int: param mindate: Min datetime at returnere resultater fra.: type mindate: datetime classplexapi.myplex.Section(server, data, initpath=None, parent=None) lart

baser: plexapi.base.PlexObject

Dette refererer til et delt afsnit. Den rå HML for de data, der præsenteres her, kan findes på: https://plex.tv/api/servers/{machineId}/shared_servers/{serverId}

variabler

  • TAG (str) – sektion

  • id (int) – delt sektion id

  • sectionKey (str) – hvilken nøgle vi bruger til dette afsnit

  • Titel (str) – titel på sektionen

  • sectionid (str) – delt sektion id

  • type (str) – film, tvvis, kunstner

  • delt (bool) – hvis dette afsnit deles med brugeren

history(maksresultater=9999999, mindate=None)

få alle spille historie for en bruger til dette afsnit i denne delte server.: param maks. resultater: Returner kun det angivne antal resultater (valgfrit).: skriv maks. resultater: int: param mindate: Min datetime at returnere resultater fra.: type mindate: datetime

classplexapi.myplex.MyPlexServerShare(server, data, initpath=None, parent=None)

baser: plexapi.base.PlexObject

repræsenterer en enkelt brugers serverreference. Bruges til bibliotek deling.

variabler

  • id (int) – id for denne del

  • serverId (str) – hvad id-pleksen bruger til dette.

  • machineIdentifier (str) – serverne machineIdentifier

  • navn (str) – serverne navn

  • lastSeenAt (datetime) – sidst tilsluttet serveren?

  • numLibraries (int) – Samlet antal biblioteker

  • allLibraries (bool) – sandt, hvis alle biblioteker deles med denne bruger.

  • ejet (bool) – 1 hvis serveren ejes af brugeren

  • afventer (bool) – sandt, hvis invitationen afventer.

section(navn) Lira

returnererSection der matcher det angivne navn.

parametre

navn (str) – navn på det afsnit, der skal returneres.

sections() list

returnerer en liste over alleSection objekter, der deles med denne bruger.

history(maksresultater=9999999, mindate=None).: param maksresultater: kun returnere det angivne antal resultater (valgfrit).: skriv maks. resultater: int: param mindate: Min datetime at returnere resultater fra.: type mindate: datetime classplexapi.myplex.MyPlexResource(server, data, initpath=None, parent=None)

baser: plexapi.base.PlexObject

dette objekt repræsenterer ressourcer, der er forbundet til din Pleksserver, der kan levere indhold som f.eks. Pleksserver, iPhone eller Android kunder osv. De data, der præsenteres her, kan findes på: https://plex.tv/api/resources?includeHttps=1&includeRelay=1

variabler

  • TAG (str) – ‘enhed’

  • nøgle (str) – ‘https://plex.tv/api/resources?includeHttps=1&includeRelay=1 ‘

  • accessToken (str) – denne ressourcer accesstoken.

  • clientIdentifier (str) – unikt ID for denne ressource.

  • forbindelser (liste) – Liste over ResourceConnection objekterfor denne ressource.

  • createdAt (datetime) – tidsstempel denne ressource først tilsluttet din server.

  • enhed (str) – bedste gæt på den type enhed, Dette er (PS, iPhone, Linuks osv.).

  • hjem (bool) – ukendt

  • lastSeenAt (datetime) – tidsstempel denne ressource sidst tilsluttet.

  • navn (str) – beskrivende navn på denne ressource.

  • ejet (bool) – sandt, hvis denne ressource er en af dine egne (du er logget ind på den).

  • platform (str) – os ressourcen kører (f.eks.)

  • platformVersion (str) – version af platformen.

  • tilstedeværelse (bool) – sandt, hvis ressourcen er online

  • produkt (str) – Pleks produkt (Pleks medieserver, Pleks til iOS, Pleks internet osv.)

  • productVersion (str) – Version af produktet.

  • giver (str) – liste over tjenester, denne ressource giver (klient,server, afspiller, pubsub-afspiller osv.)

  • synkroniseret (bool) – ukendt (muligvis sandt, hvis ressourcen har synkroniseret indhold?)

connect(ssl=None, timeout=None)

Returnerer et nytPlexServer ellerPlexClient objekt.Ofte er der mere end en adresse angivet til en server eller klient.Denne funktion prioriterer lokale forbindelser før fjernbetjening eller relæ og HTTPS før HTTP.Efter at have forsøgt at oprette forbindelse til alle tilgængelige adresser for denne ressource ogforudset mindst en forbindelse var vellykket, er Pleksserverobjektet bygget og returneret.

parametre

  • ssl (bool, valgfrit) – Indstil True til kun at oprette forbindelse til HTTPS-forbindelser. Indstil falsk tilkun oprette forbindelse til HTTP-forbindelser. Indstil ingen (standard) for at oprette forbindelse til anyHTTP-eller HTTPS-forbindelse.

  • timeout (int, valgfrit) – timeout i sekunder for at forsøge hver forbindelse.

hæver

NotFound – når den ikke kan oprette forbindelse til nogen adresser til denne ressource.

classplexapi.myplex.ResourceConnection(server, data, initpath=None, parent=None)

baser:plexapi.base.PlexObject

repræsenterer et Ressourceforbindelsesobjekt fundet inden forMyPlexResource objekter.

variabler

  • TAG (str) – ‘forbindelse’

  • adresse (str) – lokal IP – adresse

  • httpuri (str) – fuld lokal adresse

  • lokal (bool) – sand hvis lokal

  • port (int) – 32400

  • protokol (str) – HTTP eller https

  • uri (str) – ekstern adresse

klasseplexapi.myplex.MyPlexDevice(server, data, initpath=ingen, forælder=ingen):plexapi.base.PlexObject

dette objekt repræsenterer ressourcer, der er forbundet til din Pleksserver, der giver mulighed for afspilning fra din Pleksserver,iPhone-eller Android-klienter, Pleksserver, denne API osv. Data præsenteret her kan findes på:https://plex.tv/devices.xml

variabler

  • TAG (str) – ‘enhed’

  • nøgle (str) – ‘https://plex.tv/devices.xml’

  • clientIdentifier (str)) – unikt ID for denne ressource.

  • forbindelser (liste) – Liste over forbindelsesurier til enheden.

  • enhed (str) – bedste gæt på den type enhed, Dette er (iPad, AFTB osv.).

  • id (str) – Mypleks ID af enheden.

  • model (str) – Model af enheden (bueller, Linuks, h86_64 osv.)

  • navn (str) – enhedens værtsnavn.

  • platform (str) – os ressourcen kører (f.eks.)

  • platformVersion (str) – version af platformen.

  • produkt (str))

  • produktversion (streng) – Version af produktet.

  • giver (str) – liste over tjenester denne ressource giver (klient, controller,sync-target, player, pubsub-player).

  • publicAddress (str) – offentlig IP-adresse.

  • screenDensity (str) – ukendt

  • screenResolution (str) – skærmopløsning (750h1334, 1242h2208 osv.)

  • token (str) – godkendelsestoken for enheden.

  • leverandør (str) – enhedsleverandør (ubuntu osv.).

  • version (str) – ukendt (1, 2, 1.3.3.3148-b38628e, 1.3.15 osv.)

connect(timeout=None)

returnerer en nyPlexClient ellerPlexServernogle gange er der mere end en adresse angivet for en server eller klient.Efter at have forsøgt at oprette forbindelse til alle tilgængelige adresser til denne klient og antagemindst en forbindelse var vellykket, det Plekskliente objekt er bygget og returneret.

hæver

NotFound – når den ikke kan oprette forbindelse til nogen adresser til denne enhed.

delete() ret

fjern denne enhed fra din konto.

syncItems() venstre

returnerer en forekomst afSyncList for nuværende enhed.

hæver

Badanmodning-når enheden ikke giver sync-target.

classplexapi.myplex.MyPlexPinLogin(session=None, recesttimeout=None, headers=None)

baser: object

mypleks PIN login klasse, som understøtter at få de fire tegn PIN, som brugeren mustenter på https://plex.tv/link for at godkende klienten og give et adgangstoken tilopret en MyPlexAccount forekomst.Denne Hjælper klasse understøtter en polling, gevind og tilbagekald tilgang.

  • pollingmetoden forventer, at udvikleren regelmæssigt kontrollerer, om PIN-login varsuccesfuldt ved hjælp afcheckLogin().

  • den gevindskårne tilgang forventer, at udvikleren kalderrun() og derefter på et senere tidspunkt kalderwaitForLogin() for at vente på og kontrollere resultatet.

  • tilbagekaldsmetoden er en udvidelse af den gevindskårne tilgang og forventer, at udvikleren overfører tilbagekaldsparameteren til opkaldet tilrun().Tilbagekaldelsen vil blive kaldt, når tråden venter på, at PIN-login skal lykkes entenafslutter eller udløber. Parameteren, der sendes til tilbagekaldelsen, er den modtagne godkendelsetoken eller ingen, hvis login er udløbet.

parametre

  • session (anmodninger.Session, valgfri) – brug dit eget sessionobjekt, hvis du vilcache http-svarene fra PMS

  • Anmod om timeout – int) – timeout i sekunder ved første forbindelse til plex.tv (standard config.TIMEOUT).

variabler

  • PINS (str) – ‘https://plex.tv/api/v2/pins’

  • CHECKPINS (str) – ‘https://plex.tv/api/v2/pins/{pinid}’

  • LINK (str) – ‘https://plex.tv/api/v2/pins/link’

  • pollinterval (int) – 1

  • færdig (bool) – om PIN login er færdig eller ej.

  • udløbet (bool) – om pin-login er udløbet eller ej.

  • token (str) – Token hentet via pin login.

  • pin (str) – Pin til brug for login påhttps://plex.tv/link.

run(tilbagekald=ingen, timeout=ingen).: param tilbagekald: tilbagekald kaldes med den modtagne godkendelse token (valgfrit).: type tilbagekald:konverterbar: param timeout: Timeout i sekunder venter på PIN login til at lykkes (valgfrit).: type timeout: Int hæver

  • RuntimeError – hvis tråden allerede kører.

  • RuntimeError – hvis PIN-login for den aktuelle PIN-kode er udløbet.

waitForLogin().:param tilbagekald: tilbagekald kaldes med den modtagne godkendelse token (valgfrit).: type tilbagekald:konverterbar: param timeout: Timeout i sekunder venter på PIN login til at lykkes (valgfrit).: type timeout: Int returnerer

True, hvis PIN-login lykkedes eller falsk på anden måde.

stop