classe plexapi.myplex.MyPlexAccount(username=Nenhum, senha=Nenhum, token=Nenhum, sessão=Nenhum, timeout=Nenhum)¶

Bases: plexapi.base.PlexObject

MyPlex de conta e informações de perfil. Este objecto representa os dados encontrados na conta myplex.tv servidores no url https://plex.tv/users/account. Pode criar este objectivo directamente passando no seu nome de utilizador & senha (ou item). Existe também um método conveniencemetd fornecido em myPlexAccount() que irá criar e devolver este objecto.

parâmetros

• utilizador – str) – o seu utilizador MyPlex.

• senha – str) – a sua senha do MyPlex.sessão (pedidos.Sessão, opcional) – Use o seu próprio objecto de sessão se quiser associar as respostas http a partir de PMS

• tempo-limite (int) – tempo-limite em segundos na ligação inicial ao myplex (configuração por omissão.LIMITE).

Variáveis

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

• chave (str) – ‘https://plex.tv/users/account’

• authenticationToken (str) – Desconhecido.

• certificateVersion (str) – desconhecido.cloudSyncDevice (str) – desconhecido.

• email (str) – o seu endereço de email Plex actual.

• direitos (lista<str>) – lista de dispositivos que é permitido utilizar nesta conta.convidado (bool) – desconhecido.

• home (bool) – desconhecido.

• homeSize (int) – desconhecido.

• id (int) – o seu ID da Conta Plex.

• locale (str) – a sua localização Plex

• mailing_ list_status (str) – o estado actual da sua lista de correio.

• maxHomeSize (int) – desconhecido.

• queueEmail – str) – endereço de E-mail para adicionar itens à sua fila de espera posterior.

• queueueuid (str) – desconhecido.

• Restrito (bool) – desconhecido.

• roles – (List<str>) Lit of account roles. Inscrição Plexpass listada aqui.

• scrobbleTypes (str) – Descrição

• seguro (bool) – Descrição

• subscriptionActive (bool) – True se o seu subsctiption está ativo.

• subscriptionFeatures – (List<str>) Lista de recursos permitidos em sua assinatura.

subscriptionPlan (str) – nome do plano de Subscrição.

• subscriptionStatus (str) – representação de cadeias de subscriptionativas.

• thumb (str) – URL da sua miniatura da conta.

• título (str) – desconhecido. – Parece um nome falso.

• utilizador (str) – o seu utilizador da conta.

• uuid (str) – desconhecido.

• _ Token (str) – Token used to access this client.

• _session – obj) – solicita o objecto de sessão usado para aceder a este cliente.

device(nome=Nenhum, clientId=Nenhum)¶

Retorna MyPlexDevice que corresponde ao nome especificado.

Parameters

• name (str) – Name to match against.

• clientId (str) – clientIdentifier para igualar.

devices()¶

devolve uma lista de todos os MyPlexDevice objectos ligados ao servidor.

resource(nome)¶

Devolve o MyPlexResource que corresponde ao nome indicado.

Parameters

name (str) – Name to match against.

resources()¶

devolve uma lista de todos os MyPlexResource objectos ligados ao servidor.

inviteFriend(usuário, servidor, secções=Nenhum, allowSync=False, allowCameraUpload=False, allowChannels=False, filterMovies=Nenhum, filterTelevision=Nenhum, filterMusic=Nenhum)¶

Partilhar biblioteca de conteúdo com o usuário especificado.

Parameters

• user (MyPlexUser) – MyPlexUser object, username, or Email of the user to be added.

• server (PlexServer) – PlexServer object, or machineIdentifiercontaining the library sections to share.

• seções (List<LibrarySection>) – Lista de LibrarySection objecs, ou namesto ser compartilhada (padrão Nenhum). as seções devem ser definidas para atualizar as bibliotecas compartilhadas.

• allowSync (Bool) – Set True para permitir que o usuário sincronize o conteúdo.

• allowCameraUpload (Bool) – define True para permitir ao utilizador enviar fotografias.

• allowChannels – Bool) – Set True para permitir que o usuário utilize os canais instalados.

• filterMovies (Dict) – Dict contendo a chave ‘contentRating’ e/ou ‘label’ cada um definido numa lista de valores a filtrar. ex: {‘contentRating’:, ‘label’:}

• filterTelevision (Dict) – Dict contendo a chave ‘contentRating’ e/ou ‘label’ cada um definido numa lista de valores a filtrar. ex: {‘contentRating’:, ‘label’:}

• filterMusic (Dict) – Dict contendo a chave ‘label’ definida numa lista de valores a filtrar.ex: {‘label’:}

createHomeUser(usuário, servidor, secções=Nenhum, allowSync=False, allowCameraUpload=False, allowChannels=False, filterMovies=Nenhum, filterTelevision=Nenhum, filterMusic=Nenhum)¶

Partilhar biblioteca de conteúdo com o usuário especificado.

Parameters

• user (MyPlexUser) – MyPlexUser object, username, or Email of the user to be added.

• server (PlexServer) – PlexServer object, or machineIdentifiercontaining the library sections to share.

• seções (List<LibrarySection>) – Lista de LibrarySection objecs, ou namesto ser compartilhada (padrão Nenhum). as seções devem ser definidas para atualizar as bibliotecas compartilhadas.

• allowSync (Bool) – Set True para permitir que o usuário sincronize o conteúdo.

• allowCameraUpload (Bool) – define True para permitir ao utilizador enviar fotografias.

• allowChannels – Bool) – Set True para permitir que o usuário utilize os canais instalados.

• filterMovies (Dict) – Dict contendo a chave ‘contentRating’ e/ou ‘label’ cada um definido numa lista de valores a filtrar. ex: {‘contentRating’:, ‘label’:}

• filterTelevision (Dict) – Dict contendo a chave ‘contentRating’ e/ou ‘label’ cada um definido numa lista de valores a filtrar. ex: {‘contentRating’:, ‘label’:}

• filterMusic (Dict) – Dict contendo a chave ‘label’ definida numa lista de valores a filtrar.ex: {‘label’:}

createExistingUser(usuário, servidor, secções=Nenhum, allowSync=False, allowCameraUpload=False, allowChannels=False, filterMovies=Nenhum, filterTelevision=Nenhum, filterMusic=Nenhum)¶

Partilhar biblioteca de conteúdo com o usuário especificado.

Parameters

• user (MyPlexUser) – MyPlexUser object, username, or Email of the user to be added.

• server (PlexServer) – PlexServer object, or machineIdentifiercontaining the library sections to share.

• seções (List<LibrarySection>) – Lista de LibrarySection objecs, ou namesto ser compartilhada (padrão Nenhum). as seções devem ser definidas para atualizar as bibliotecas compartilhadas.

• allowSync (Bool) – Set True para permitir que o usuário sincronize o conteúdo.

• allowCameraUpload (Bool) – define True para permitir ao utilizador enviar fotografias.

• allowChannels – Bool) – Set True para permitir que o usuário utilize os canais instalados.

• filterMovies (Dict) – Dict contendo a chave ‘contentRating’ e/ou ‘label’ cada um definido numa lista de valores a filtrar. ex: {‘contentRating’:, ‘label’:}

• filterTelevision (Dict) – Dict contendo a chave ‘contentRating’ e/ou ‘label’ cada um definido numa lista de valores a filtrar. ex: {‘contentRating’:, ‘label’:}

• filterMusic (Dict) – Dict contendo a chave ‘label’ definida numa lista de valores a filtrar.ex: {‘label’:}

removeFriend(utilizador)¶

remova o utilizador indicado de toda a partilha.

parâmetros

utilizador (str) – MyPlexUser, utilizador, e-mail do utilizador a adicionar.

removeHomeUser(utilizador) parâmetros

utilizador (str) – MyPlexUser, utilizador, e-mail do utilizador a remover de casa.

updateFriend(usuário, servidor, secções=Nenhum, removeSections=False, allowSync=Nenhum, allowCameraUpload=Nenhum, allowChannels=Nenhum, filterMovies=Nenhum, filterTelevision=Nenhum, filterMusic=Nenhum) n

de Atualização especificado do usuário configurações de compartilhamento.

Parameters

• user (MyPlexUser) – MyPlexUser object, username, or Email of the user to be updated.

• server (PlexServer) – PlexServer object, or machineIdentifiercontaining the library sections to share.

• seções (List<LibrarySection>) – Lista de LibrarySection objecs, ou namesto ser compartilhada (padrão Nenhum). as seções devem ser definidas para atualizar as bibliotecas compartilhadas.

• removeSections (Bool) – Set True to remove all shares. Substitui as secções.

• allowSync (Bool) – Set True para permitir que o usuário sincronize o conteúdo.

• allowCameraUpload (Bool) – define True para permitir ao utilizador enviar fotografias.

• allowChannels – Bool) – Set True para permitir que o usuário utilize os canais instalados.

• filterMovies (Dict) – Dict contendo a chave ‘contentRating’ e/ou ‘label’ cada um definido numa lista de valores a filtrar. ex: {‘contentRating’:, ‘label’:}

• filterTelevision (Dict) – Dict contendo a chave ‘contentRating’ e/ou ‘label’ cada um definido numa lista de valores a filtrar. ex: {‘contentRating’:, ‘label’:}

• filterMusic (Dict) – Dict contendo a chave ‘label’ definida numa lista de valores a filtrar.ex: {‘label’:}

user(utilizador)¶

Devolve o MyPlexUser que corresponde ao E-mail ou ao utilizador indicado.

parâmetros

utilizador – str) – utilizador, e-mail ou id do utilizador a devolver.

users()¶

devolve uma lista de todos os objectos MyPlexUser ligados à sua conta.Isso inclui tanto amigos e convites pendentes. Pode consultar o utilizador.amigo todistinguish entre os dois.

optOut(reprodução=nenhuma, biblioteca=nenhuma)¶

Opt in or out of sharing stuff with plex.Ver: https://www.plex.tv/about/privacy-legal/

syncItems(cliente=Nenhum, clientId=Nenhum)¶

Retorna uma instância de SyncList para o cliente especificado.

Parameters

• client (MyPlexDevice) – a client to query SyncItems for.

• clientId – str) – um identificador de um cliente para consultar Sincitems.

Se tanto o cliente como o cliente preferissem.Se nem o cliente nem o cliente fornecessem o cliente seria definido como o identificador do cliente atual.

sync(sync_item, client=None, clientId=None)¶

Adds specified sync item for the client. É sempre mais fácil usar métodos definidos diretamente nos mediaobjects, e.g. sync()sync().

Parâmetros

• cliente (MyPlexDevice) – um cliente para o qual você precisa adicionar SyncItem para.

• clientId – str) – um identificador de um cliente para o qual você precisa adicionar SyncItem.

• sync_item (SyncItem) – objeto Sincitem preparado com todos os campos definidos.

Se tanto o cliente como o cliente preferissem.Se nem o cliente nem o cliente fornecessem o cliente seria definido como o identificador do cliente atual.

Devolve

uma instância de syncItem criado.

Return type

SyncItem

Raises

• BadRequest – When client with provided clientId was not found.

• BadRequest – Provided client doesn’t provides sync-target.

claimToken()¶

Devolve um str, um novo “claim-token”, que poderá usar para registar a sua nova instância do servidor Plex à sua conta.Ver: https://hub.docker.com/r/plexinc/pms-docker/https://www.plex.tv/claim/

history(maxresultados=9999999, mindate=None)¶

Get Play History for all library sections on all servers for the owner.: param maxresults: return Only the specified number of results (optional).: type maxresults: int: param mindate: Min datetime to return results from.: tipo mindate: datetime

videoOnDemand()¶

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 codigo.

parâmetros

pin – str) – o código pin de ligação de 4 dígitos.

classeplexapi.myplex.MyPlexUser(servidor de dados, initpath=Nenhum, parent=None)¶

Bases: plexapi.base.PlexObject

Este objeto representa de não-assinado em usuários como amigos e linkedaccounts. Nota: Isto não deve ser confundido com o MyPlexAccountque é a sua conta específica. O XML bruto para os dados apresentados pode ser encontrado em: https://plex.tv/api/users/

Variáveis

• a TAG (str) – ‘Usuário’

• chave (str) – ‘https://plex.tv/api/users/’

• allowCameraUpload (bool) – True se este usuário pode fazer upload de imagens.

• allowChannels (bool) – True se este utilizador tiver acesso a canais.

• allowSync – bool) – True if this user can sync.

• email (str) – endereço de E-mail do utilizador ([email protected]).

• filterAll (str) – desconhecido.

• filterMovies (str) – desconhecido.

• filterMusic (str) – desconhecido.

• filterPhotos (str) – desconhecido.

• filterTelevision (str) – desconhecido.

• home (bool) – desconhecido.

• id (int) – ID da Conta Plex do utilizador.

• protegido (False) – desconhecido (possivelmente activado por SSL?).

• recommendationsPlaylistId (str) – desconhecido.

• Restrito (str) – desconhecido.

• polegar (str) – ligação ao avatar dos utilizadores.

• title (str) – parece ser um aliad para o nome de utilizador.

• utilizador – str) – utilizador.

• servidores – Servidores compartilhados entre o usuário e o amigo

server(nome)¶

Retorna MyPlexServerShare que corresponde ao nome especificado.

Parameters

name (str) – Name of the server to return.

history(maxresults=9999999, mindate=None)¶

Get all Play History for a user in all shared servers.: param maxresults: return Only the specified number of results (optional).: type maxresults: int: param mindate: Min datetime to return results from.: tipo mindate: datetime

classeplexapi.myplex.Section(servidor de dados, initpath=Nenhum, parent=None)¶

Bases: plexapi.base.PlexObject

Isso refere-se a uma secção partilhada. O XML bruto para os dados apresentados pode ser encontrado em: https://plex.tv/api/servers/{machineId}/shared_servers/{serverId}

Variáveis

• a TAG (str) – seção

• id (int) – secção partilhada id

• sectionKey (str) – chave que usamos para esta seção

• title (str) – Título da seção

• sectionId (str) – secção partilhada id

• tipo (str) – filme, tvshow, artista

• compartilhada (bool) – Se esta seção é compartilhada com o usuário

history(maxresults=9999999, mindate=Nenhum)¶

todo o Histórico de um usuário, para esta seção deste servidor compartilhado.: param maxresults: Devolver apenas o número especificado de resultados (opcional).: type maxresults: int: param mindate: Min datetime to return results from.: type mindate: datetime

classMyPlexServerShare(server, data, initpath=None, parent=none)¶

Bases: plexapi.base.PlexObject

representa uma referência ao servidor de um único utilizador. Usado para partilha de bibliotecas. variáveis

• id (int) – id para esta partilha

• serverId (str) – que id plex usa para isto.

• machineIdentifier (str) – Os servidores machineIdentifier

• nome (str) – Os servidores de nome

• lastSeenAt (datetime) – Última conectado ao servidor?

• numbrários – int) – número Total de bibliotecas

• allbraries (bool) – verdadeiro se todas as bibliotecas forem partilhadas com este utilizador.

• propriedade (bool) – 1 Se o servidor For propriedade do utilizador

• pendente (bool) – verdadeiro se o convite estiver pendente.

section(nome)¶

Retorna Section que corresponde ao nome especificado.

Parameters

name – str) – Name of the section to return.

sections()¶

devolve uma lista de todos os objectos Section partilhados com este utilizador.

history(maxresults=9999999, mindate=None)¶

Get all Play History for a user in this shared server.: param maxresults: return Only the specified number of results (optional).: type maxresults: int: param mindate: Min datetime to return results from.: tipo mindate: datetime

classeplexapi.myplex.MyPlexResource(servidor de dados, initpath=Nenhum, parent=None)¶

Bases: plexapi.base.PlexObject

Este objeto representa de recursos ligados ao seu Plex servidor que pode providecontent como o Plex Media Servidores, iPhone ou Android, clientes, etc. As matérias xmlfor os dados aqui apresentados podem ser encontrados em:https://plex.tv/api/resources?includeHttps=1&includeRelay=1

Variáveis

• a TAG (str) – ‘Dispositivo’

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

• accessToken (str) – Este recursos accesstoken.

• clientIdentifier (str) – ID único para este recurso.

• connections (list) – List of ResourceConnection objects for this resource.

• createdAt – datetime) – Timestamp este recurso ligado pela primeira vez ao seu servidor.

• dispositivo (str) – melhor palpite sobre o tipo de dispositivo que este é (PS, iPhone, Linux, etc).

• home (bool) – desconhecido

• lastSeenAt (datetime) – Timestamp this resource last connected.

• name – str) – nome descritivo deste recurso.

• propriedade (bool) – True se este recurso for um dos seus (registou-se nele).

• plataforma (str) – OS o recurso está em execução (Linux, Windows, Chrome, etc.)

• platformVersion (str) – versão da plataforma.

• presence (bool) – True if the resource is online

• product (str) – Plex product (Plex Media Server, Plex for iOS, Plex Web, etc.)

• productVersion (str) – versão do produto.

• Fornece (str) – lista de serviços que este recurso fornece (cliente, servidor,jogador, pubsub-player, etc.)

• synced (bool) – Unknown (possibly True if the resource has synced content?)

connect(ssl=Nenhum, timeout=Nenhum)¶

Retorna um novo PlexServer ou PlexClient objeto.Muitas vezes há mais de um endereço especificado para um servidor ou cliente.Esta função irá priorizar as conexões locais antes de remotos ou relay e HTTPS antes de HTTP.Depois de tentar se conectar a todos os endereços disponíveis para este recurso e acumular pelo menos uma conexão foi bem sucedida, o objeto PlexServer é construído e devolvido.

parâmetros

• ssl (bool, opcional) – definir verdadeiro para se ligar apenas às ligações dos HTTPS. Configura o False para se ligar apenas às ligações de HTTP. Não definir nenhuma ligação (por omissão) a qualquer ligaçãohttp ou HTTPS.

• tempo-limite (int, opcional) – o tempo-limite em segundos para tentar cada ligação.

aumenta

NotFound – quando não é possível ligar-se a quaisquer endereços para este recurso.

classeplexapi.myplex.ResourceConnection(servidor de dados, initpath=Nenhum, parent=None)¶

Bases: plexapi.base.PlexObject

Representa um Recurso de Conexão objeto encontrado dentro deMyPlexResource objetos.

Variáveis

• a TAG (str) – ‘Conexão’

• endereço (str) – endereço IP Local

• httpuri (str) – local address

• local (bool) – Verdadeiro se o local

• porta (int) – 32400

• protocolo (str) – HTTP ou HTTPS

• uri (str) – Endereço externo

classeplexapi.myplex.MyPlexDevice(servidor de dados, initpath=Nenhum, parent=None)¶

Bases: plexapi.base.PlexObject

este objeto representa recursos conectados ao seu servidor Plex que provideplayback capacidade de seus clientes Plex, iPhone ou Android, Plex Web,esta API, etc. As matérias xml para os dados aqui apresentados podem ser encontrados em:https://plex.tv/devices.xml

Variáveis

• a TAG (str) – ‘Dispositivo’

• chave (str) – ‘https://plex.tv/devices.xml’

• clientIdentifier (str) – IDENTIFICAÇÃO exclusiva para este recurso.

• conexões (lista) – Lista de URIs de conexão para o dispositivo.

• dispositivo (str) – melhor palpite sobre o tipo de dispositivo que este é (Linux, iPad, AFTB, etc).

• id (str) – id MyPlex do dispositivo.

• model (str) – Model of the device (bueller, Linux, x86_64, etc.)

• name – str) – Hostname of the device.

• plataforma (str) – OS o recurso está em execução (Linux, Windows, Chrome, etc.)

• platformVersion (str) – versão da plataforma.

• produto (str) – Plex (Plex Media Server, Plex for iOS, Plex Web, etc.)

• productVersion (texto) – versão do produto.

• Fornece (str) – lista de serviços que este recurso fornece (cliente, controlador,alvo sincronizado, jogador, pubsub-player).

• publicAddress (str) – endereço IP público.resolução do ecrã (750×1334, 1242×2208, etc.)

• token – str) – token de autenticação Plex para o dispositivo.

• vendedor (str) – vendedor de dispositivos (ubuntu, etc).

• versão (str) – desconhecida (1, 2, 1.3.3.3148-b38628e, 1.3.15, etc.)

connect(timeout=Nenhum)¶

Retorna um novo PlexClient ou PlexServeràs Vezes existe mais de um endereço especificado para um servidor ou cliente.Depois de tentar se conectar a todos os endereços disponíveis para este cliente e assumir que pelo menos uma conexão foi bem sucedida, o objeto PlexClient é construído e devolvido.

aumenta

NotFound – quando não é possível ligar – se a quaisquer endereços para este dispositivo.

delete()¶

remova este dispositivo da sua conta.

syncItems()¶

devolve uma instância de SyncList para o dispositivo actual.

aumenta

BadRequest-quando o dispositivo não fornece sync-target.

classeplexapi.myplex.MyPlexPinLogin(session=Nenhum, requestTimeout=Nenhum, cabeçalhos=Nenhum)¶

Bases: object

MyPlex PIN classe de login que suporta a obtenção de quatro caracteres PIN que o usuário mustenter no https://plex.tv/link para autenticar o cliente e proporcionar um token de acesso tocreate um MyPlexAccount instância.Esta classe auxiliar suporta uma aproximação de votação, threaded e callback.

• a abordagem de votação espera que o programador verifique periodicamente se a autenticação PIN foi bem sucedida usando checkLogin().

• a abordagem roscada espera que o programador invoquerun() e, em seguida, numa chamada posteriorwaitForLogin() espere e verifique o resultado.

• a abordagem de callback é uma extensão da abordagem roscada e espera que o desenvolvimento passe o parâmetro de callback para a chamada para run().O callback será chamado quando o thread espera que o login PIN seja bem sucedido ou expire. O parâmetro passado para o callback é o autenticationtoken recebido ou nenhum se o login expirou.

parâmetros

• sessão (pedidos.Sessão, opcional) – Use o seu próprio objecto de sessão se quiser associar as respostas http do PMS

• requestTimeout – int) – tempo-limite em segundos na ligação inicial ao plex.tv (configuração padrão.LIMITE).

Variáveis

• PINOS (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

• terminado (bool) – Se o pino de início de sessão tenha terminado ou não.

• expirou (bool) – quer o login do pin tenha caducado ou não.

• token (str) – Token obtido através do login pin.

• pin (str) – Pin a usar para o login em https://plex.tv/link.

run(callback=nenhum, tempo-limite=nenhum)¶

inicia o tópico que monitoriza o estado de autenticação PIN.: param callback: Callback chamado com o token de autenticação recebido (opcional).: type callback:Callable: param timeout: Timeout in seconds waiting for the PIN login to succeed (optional).: tempo-limite do tipo: int

aumenta

• RuntimeError-se o tópico já estiver em execução.

• Rntimeerror – se a autenticação PIN do PIN actual tiver expirado.

waitForLogin()¶

espera que o login PIN tenha sucesso ou expire.:chamada de volta do param: chamada de volta com o token de autenticação recebido (opcional).: type callback:Callable: param timeout: Timeout in seconds waiting for the PIN login to succeed (optional).: type timeout: int

Devolve

True se a autenticação PIN tiver sucesso ou False de outra forma.

stop