digiKam
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
DigikamGenericMediaServerPlugin::DLNAMediaServer Class Reference
+ Inheritance diagram for DigikamGenericMediaServerPlugin::DLNAMediaServer:

Public Member Functions

void addAlbumsOnServer (const MediaServerMap &map)
 
 DLNAMediaServer (const char *friendly_name, bool show_ip=false, const char *uuid=nullptr, NPT_UInt16 port=0, bool port_rebind=false)
 
NPT_Result SetupIcons () override
 

Static Public Member Functions

static NPT_String BuildSafeResourceUri (const NPT_HttpUrl &base_uri, const char *host, const char *file_path)
 Class methods. More...
 

Protected Member Functions

virtual PLT_MediaObject * BuildFromFilePath (const NPT_String &filepath, const PLT_HttpRequestContext &context, bool with_count=true, bool keep_extension_in_title=false, bool allip=false)
 
virtual NPT_String BuildResourceUri (const NPT_HttpUrl &base_uri, const char *host, const char *file_path)
 
virtual NPT_Result ExtractResourcePath (const NPT_HttpUrl &url, NPT_String &file_path)
 Overridable methods. More...
 
virtual NPT_Result GetFilePath (const char *object_id, NPT_String &filepath)
 
NPT_Result OnBrowseDirectChildren (PLT_ActionReference &action, const char *object_id, const char *filter, NPT_UInt32 starting_index, NPT_UInt32 requested_count, const char *sort_criteria, const PLT_HttpRequestContext &context) override
 
NPT_Result OnBrowseMetadata (PLT_ActionReference &action, const char *object_id, const char *filter, NPT_UInt32 starting_index, NPT_UInt32 requested_count, const char *sort_criteria, const PLT_HttpRequestContext &context) override
 PLT_MediaServerDelegate methods. More...
 
NPT_Result OnSearchContainer (PLT_ActionReference &action, const char *object_id, const char *search_criteria, const char *filter, NPT_UInt32 starting_index, NPT_UInt32 requested_count, const char *sort_criteria, const PLT_HttpRequestContext &context) override
 
virtual bool ProcessFile (const NPT_String &, const char *filter=nullptr)
 
NPT_Result ProcessFileRequest (NPT_HttpRequest &request, const NPT_HttpRequestContext &context, NPT_HttpResponse &response) override
 
virtual NPT_Result ServeFile (const NPT_HttpRequest &request, const NPT_HttpRequestContext &context, NPT_HttpResponse &response, const NPT_String &file_path)
 
 ~DLNAMediaServer () override
 

Protected Attributes

Private *const d
 

Detailed Description

File Media Server for digiKam. The DLNAMediaServer class is based on PLT_MediaServer implementation for a file system backed Media Server with album contents.

Constructor & Destructor Documentation

◆ DLNAMediaServer()

DigikamGenericMediaServerPlugin::DLNAMediaServer::DLNAMediaServer ( const char *  friendly_name,
bool  show_ip = false,
const char *  uuid = nullptr,
NPT_UInt16  port = 0,
bool  port_rebind = false 
)
explicit

◆ ~DLNAMediaServer()

DigikamGenericMediaServerPlugin::DLNAMediaServer::~DLNAMediaServer ( )
overrideprotected

Member Function Documentation

◆ addAlbumsOnServer()

void DigikamGenericMediaServerPlugin::DLNAMediaServer::addAlbumsOnServer ( const MediaServerMap &  map)

◆ BuildFromFilePath()

PLT_MediaObject * DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::BuildFromFilePath ( const NPT_String &  filepath,
const PLT_HttpRequestContext &  context,
bool  with_count = true,
bool  keep_extension_in_title = false,
bool  allip = false 
)
protectedvirtualinherited

References DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::BuildResourceUri(), DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::d, and DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::PLT_MediaItem.

Referenced by DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::OnBrowseDirectChildren(), and DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::OnBrowseMetadata().

◆ BuildResourceUri()

NPT_String DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::BuildResourceUri ( const NPT_HttpUrl &  base_uri,
const char *  host,
const char *  file_path 
)
protectedvirtualinherited

References DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::BuildSafeResourceUri().

Referenced by DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::BuildFromFilePath().

◆ BuildSafeResourceUri()

NPT_String DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::BuildSafeResourceUri ( const NPT_HttpUrl &  base_uri,
const char *  host,
const char *  file_path 
)
staticinherited

Class methods.

Referenced by DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::BuildResourceUri().

◆ ExtractResourcePath()

NPT_Result DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::ExtractResourcePath ( const NPT_HttpUrl &  url,
NPT_String &  file_path 
)
protectedvirtualinherited

Overridable methods.

References DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::d.

Referenced by DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::ProcessFileRequest().

◆ GetFilePath()

NPT_Result DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::GetFilePath ( const char *  object_id,
NPT_String &  filepath 
)
protectedvirtualinherited

Referenced by DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::OnBrowseDirectChildren(), DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::OnBrowseMetadata(), and DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::OnSearchContainer().

◆ OnBrowseDirectChildren()

NPT_Result DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::OnBrowseDirectChildren ( PLT_ActionReference &  action,
const char *  object_id,
const char *  filter,
NPT_UInt32  starting_index,
NPT_UInt32  requested_count,
const char *  sort_criteria,
const PLT_HttpRequestContext &  context 
)
overrideprotectedinherited

References DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::BuildFromFilePath(), DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::d, DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::GetFilePath(), and DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::ProcessFile().

◆ OnBrowseMetadata()

NPT_Result DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::OnBrowseMetadata ( PLT_ActionReference &  action,
const char *  object_id,
const char *  filter,
NPT_UInt32  starting_index,
NPT_UInt32  requested_count,
const char *  sort_criteria,
const PLT_HttpRequestContext &  context 
)
overrideprotectedinherited

PLT_MediaServerDelegate methods.

References DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::BuildFromFilePath(), and DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::GetFilePath().

◆ OnSearchContainer()

NPT_Result DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::OnSearchContainer ( PLT_ActionReference &  action,
const char *  object_id,
const char *  search_criteria,
const char *  filter,
NPT_UInt32  starting_index,
NPT_UInt32  requested_count,
const char *  sort_criteria,
const PLT_HttpRequestContext &  context 
)
overrideprotectedinherited

References DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::GetFilePath().

◆ ProcessFile()

bool DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::ProcessFile ( const NPT_String &  ,
const char *  filter = nullptr 
)
protectedvirtualinherited

Referenced by DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::OnBrowseDirectChildren().

◆ ProcessFileRequest()

NPT_Result DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::ProcessFileRequest ( NPT_HttpRequest &  request,
const NPT_HttpRequestContext &  context,
NPT_HttpResponse &  response 
)
overrideprotectedinherited

References DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::d, DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::ExtractResourcePath(), and DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::ServeFile().

◆ ServeFile()

NPT_Result DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::ServeFile ( const NPT_HttpRequest &  request,
const NPT_HttpRequestContext &  context,
NPT_HttpResponse &  response,
const NPT_String &  file_path 
)
protectedvirtualinherited

References Digikam::DImg::copyQImage(), and Digikam::DImg::isNull().

Referenced by DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::ProcessFileRequest().

◆ SetupIcons()

NPT_Result DigikamGenericMediaServerPlugin::DLNAMediaServer::SetupIcons ( )
override

Member Data Documentation

◆ d

Private* const DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::d
protectedinherited

Referenced by DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::addAlbumsOnServer(), DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::BuildFromFilePath(), DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::DLNAMediaServerDelegate(), DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::ExtractResourcePath(), DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::OnBrowseDirectChildren(), DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::ProcessFileRequest(), and DigikamGenericMediaServerPlugin::DLNAMediaServerDelegate::~DLNAMediaServerDelegate().

The documentation for this class was generated from the following files: