Skip to content

Latest commit

 

History

History
610 lines (396 loc) · 13.1 KB

dlna-server.md

File metadata and controls

610 lines (396 loc) · 13.1 KB

Dlna Server

dlna_server_controller = client.dlna_server

Class Name

DlnaServerController

Methods

Get Connection Manager

Gets Dlna media receiver registrar xml.

def get_connection_manager(self,
                          server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.get_connection_manager(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException

Get Connection Manager 2

Gets Dlna media receiver registrar xml.

def get_connection_manager_2(self,
                            server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.get_connection_manager_2(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException

Get Connection Manager 3

Gets Dlna media receiver registrar xml.

def get_connection_manager_3(self,
                            server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.get_connection_manager_3(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException

Get Content Directory

Gets Dlna content directory xml.

def get_content_directory(self,
                         server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.get_content_directory(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException

Get Content Directory 2

Gets Dlna content directory xml.

def get_content_directory_2(self,
                           server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.get_content_directory_2(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException

Get Content Directory 3

Gets Dlna content directory xml.

def get_content_directory_3(self,
                           server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.get_content_directory_3(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException

Get Description Xml

Get Description Xml.

def get_description_xml(self,
                       server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.get_description_xml(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException

Get Description Xml 2

Get Description Xml.

def get_description_xml_2(self,
                         server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.get_description_xml_2(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException

Get Icon

Gets a server icon.

def get_icon(self,
            file_name)

Parameters

Parameter Type Tags Description
file_name string Template, Required The icon filename.

Response Type

mixed

Example Usage

file_name = 'fileName4'

result = dlna_server_controller.get_icon(file_name)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
404 Not Found. ProblemDetailsException
503 DLNA is disabled. APIException

Get Icon Id

Gets a server icon.

def get_icon_id(self,
               server_id,
               file_name)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.
file_name string Template, Required The icon filename.

Response Type

mixed

Example Usage

server_id = 'serverId8'
file_name = 'fileName4'

result = dlna_server_controller.get_icon_id(server_id, file_name)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
404 Not Found. ProblemDetailsException
503 DLNA is disabled. APIException

Get Media Receiver Registrar

Gets Dlna media receiver registrar xml.

def get_media_receiver_registrar(self,
                                server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.get_media_receiver_registrar(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException

Get Media Receiver Registrar 2

Gets Dlna media receiver registrar xml.

def get_media_receiver_registrar_2(self,
                                  server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.get_media_receiver_registrar_2(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException

Get Media Receiver Registrar 3

Gets Dlna media receiver registrar xml.

def get_media_receiver_registrar_3(self,
                                  server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.get_media_receiver_registrar_3(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException

Process Connection Manager Control Request

Process a connection manager control request.

def process_connection_manager_control_request(self,
                                              server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.process_connection_manager_control_request(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException

Process Content Directory Control Request

Process a content directory control request.

def process_content_directory_control_request(self,
                                             server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.process_content_directory_control_request(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException

Process Media Receiver Registrar Control Request

Process a media receiver registrar control request.

def process_media_receiver_registrar_control_request(self,
                                                    server_id)

Parameters

Parameter Type Tags Description
server_id string Template, Required Server UUID.

Response Type

binary

Example Usage

server_id = 'serverId8'

result = dlna_server_controller.process_media_receiver_registrar_control_request(server_id)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException
503 DLNA is disabled. APIException