Método External.changeViewOnlineList

[O recurso associado a esta página, Reprodutor Multimídia do Windows SDK, é um recurso herdado. Foi substituído pelo MediaPlayer. O MediaPlayer foi otimizado para Windows 10 e Windows 11. A Microsoft recomenda fortemente que o novo código use o MediaPlayer em vez de Reprodutor Multimídia do Windows SDK, quando possível. A Microsoft sugere que o código existente que usa as APIs herdadas seja reescrito para usar as novas APIs, se possível.]

Observação

Este tópico descreve a funcionalidade projetada para uso por lojas online. Não há suporte para o uso dessa funcionalidade fora do contexto de um repositório online.

O método changeViewOnlineList altera a exibição em Reprodutor Multimídia do Windows para exibir uma lista gerada dinamicamente pelo repositório online.

Sintaxe

External.changeViewOnlineList(
  LibraryLocationType,
  LibraryLocationID,
  Params,
  FriendlyName,
  ListType,
  ViewMode
)

Parâmetros

LibraryLocationType [in]

Uma constante de local de biblioteca que especifica o tipo da nova exibição. Por exemplo, a constante CPGenreID especifica que o novo modo de exibição mostrará um gênero específico.

LibraryLocationID [in]

Cadeia de caracteres que contém a ID do item específico a ser mostrado no novo modo de exibição. Por exemplo, se LibraryLocationType for CPGenreID, esse parâmetro especificará a ID do gênero a ser exibida no novo modo de exibição. Essa cadeia de caracteres pode estar vazia.

Parâmetros [in]

Cadeia de caracteres que contém parâmetros que Reprodutor Multimídia do Windows passa para o plug-in da loja online chamando IWMPContentPartner::GetTemplate. Esses parâmetros não são interpretados por Reprodutor Multimídia do Windows. Eles são criados pela loja online e têm significado apenas para a loja online. Essa cadeia de caracteres pode estar vazia

FriendlyName [in]

Cadeia de caracteres que contém um nome amigável, a ser exibido por Reprodutor Multimídia do Windows, para a lista dinâmica.

ListType [in]

Uma constante de local de biblioteca que especifica o tipo dos itens na lista gerada dinamicamente. Por exemplo, se o valor desse parâmetro for CPTrackID, a lista dinâmica conterá faixas.

ViewMode [in]

Cadeia de caracteres que especifica o modo que Reprodutor Multimídia do Windows usará para exibir a lista dinâmica. O chamador deve definir esse parâmetro como um dos seguintes valores, que são definidos em contentpartner.h:

ViewModeReport

ViewModeDetails

ViewModeIcon

ViewModeTile

ViewModeOrderedList

Retornar valor

Esse método não retorna um valor.

Comentários

Quando o script em uma página de descoberta chama changeViewOnlineList, Reprodutor Multimídia do Windows passa alguns dos parâmetros junto com os métodos IWMPContentPartner::GetListContents e IWMPContentPartner::GetTemplate, que são implementados pelo plug-in da loja online. A tabela a seguir mostra a correspondência entre os parâmetros dos três métodos.

parâmetro changeViewOnlineList	Parâmetro GetListContents	Parâmetro GetTemplate
LocationType	local	local
LocationID	pContext	pContext
Params	bstrParams	bstrViewParams
ListType	bstrListType	não aplicável

Como todos os três métodos mostrados na tabela anterior são implementados pelo repositório online, você tem alguma flexibilidade na forma como usa os parâmetros. A ideia é que você forneça informações suficientes para GetListContents determinar qual lista ele deve recuperar e para GetTemplate determinar qual página de descoberta deve ser exibida em seguida. Os exemplos a seguir ilustram duas possibilidades.

Exemplo 1: uma lista dinâmica que está no catálogo da loja online

Suponha que você queira que o plug-in obtenha o conteúdo da lista dinâmica que tem uma ID de 6 no catálogo da loja online. Suponha que a lista 6 seja uma lista de faixas. Você pode fornecer ao plug-in informações suficientes fazendo a chamada a seguir.

external.changeViewOnlineList(
   "CPListID", 6, "", 
   "Songs for Today", "CPTrackID", "ViewModeDetails");

Observe que o parâmetro Params está vazio; o plug-in tem informações suficientes nos outros parâmetros.

Exemplo 2: uma lista dinâmica que não está no catálogo da loja online

Suponha que você queira que o plug-in obtenha o conteúdo de uma lista dinâmica que não esteja no catálogo da loja online. Talvez você tenha decidido ter uma lista dinâmica que inclua músicas escolhidas por um artista específico. Suponha que o artista tenha uma ID de 2 no catálogo da loja online. Você pode fazer a chamada a seguir.

external.changeViewOnlineList(
   "CPArtistID", 2, "songs picked by Sally", 
   "Sally Picks", "CPTrackID", "ViewModeDetails");

Observe que os parâmetros LocationType e LocationID não especificam a lista. Em vez disso, o parâmetro Params especifica a lista. Os parâmetros LocationType e LocationID são passados para IWMPContentPartner::GetListContents, mas nesse caso, GetListContents pode ignorá-los. Os parâmetros LocationType e LocationID também são passados para IWMPContentPartner::GetTemplate, que pode usá-los para determinar qual página de descoberta deve ser exibida com a lista dinâmica.

Requisitos

Requisito	Valor
Versão	Reprodutor Multimídia do Windows 11
DLL	Wmp.dll

Confira também

Objeto externo para repositórios online do tipo 1

IWMPContentPartner::GetListContents

IWMPContentPartnerCallback::AddListContents

IWMPContentPartner::GetTemplate

Local e Item Selecionado