/ 
Net-UPnP-1.4.10
/ Net::UPnP::AV::MediaServer

NAME

Net::UPnP::AV::MediaServer - Perl extension for UPnP.

SYNOPSIS

use Net::UPnP::ControlPoint;
use Net::UPnP::AV::MediaServer;

my $obj = Net::UPnP::ControlPoint->new();

@dev_list = $obj->search(st =>'upnp:rootdevice', mx => 3);

$devNum= 0;
foreach $dev (@dev_list) {
    $device_type = $dev->getdevicetype();
    if  ($device_type ne 'urn:schemas-upnp-org:device:MediaServer:1') {
        next;
    }
    print "[$devNum] : " . $dev->getfriendlyname() . "\n";
    unless ($dev->getservicebyname('urn:schemas-upnp-org:service:ContentDirectory:1')) {
        next;
    }
    $mediaServer = Net::UPnP::AV::MediaServer->new();
    $mediaServer->setdevice($dev);
    $mediaServer->walkcontent(callback => sub { print_content($mediaServer, @_); });
    die $mediaServer->getwalkerror() if $mediaServer->getwalkerror();
    $devNum++;
}

sub print_content {
    my ($mediaServer, $content, $indent) = @_;
    my $id = $content->getid();
    my $title = $content->gettitle();
    for ($n=0; $n<$indent; $n++) {
        print "\t";
    }
    print "$id = $title";
    if ($content->isitem()) {
        print " (" . $content->geturl();
        if (length($content->getdate())) {
            print " - " . $content->getdate();
        }
        print " - " . $content->getcontenttype() . ")";
    }
    print "\n";

}

DESCRIPTION

The package is an extension UPnP/AV media server.

METHODS

new - create new Net::UPnP::AV::MediaServer.
$mservier = Net::UPnP::AV::MediaServer();

Creates a new object. Read `perldoc perlboot` if you don't understand that.

The new object is not associated with any UPnP devices. Please use setdevice() to set the device.

setdevice - set a UPnP devices
$mservier->setdevice($dev);

Set a device to the object.

browse - browse the content directory.
@action_response = $mservier->browse(
                                    ObjectID => $objid, # 0	
                                    BrowseFlag => $browseFlag, # 'BrowseDirectChildren'
                                    Filter => $filter, # "*'
                                    StartingIndex => $startIndex, # 0
                                    RequestedCount => $reqCount, # 0
                                    SortCriteria => $sortCrit # ''
                                    );

Browse the content directory and return the action response, Net::UPnP::ActionResponse.

getcontentlist - get the content list.
@content_list = $mservier->getcontentlist(
                                    ObjectID => $objid, # 0	
                                    Filter => $filter, # "*'
                                    StartingIndex => $startIndex, # 0
                                    RequestedCount => $reqCount, # 0
                                    SortCriteria => $sortCrit # ''
                                    );

Browse the content directory and return the content list. Please see Net::UPnP::AV::Content, Net::UPnP::AV::Item and Net::UPnP::AV::Container.

walkcontent - walk a bounded content tree.
$visited = $mediaServer->walkcontent(
    ObjectID => '0', max_depth => 32, max_nodes => 4096, timeout => 30,
    callback => sub { my ($content, $depth) = @_; }
);
die $mediaServer->getwalkerror() if $mediaServer->getwalkerror();

Visits content in depth-first order without recursive calls. Container IDs are visited once per walk; root children have depth 1. All parsed items, including pending siblings, consume the node budget. The timeout covers traversal and Browse requests, excluding caller callback time. Callback exceptions propagate. The return value counts visited objects; inspect getwalkerror() for a limit or Browse failure that stopped the walk. getcontentlist() remains one-level and repeatable.

SEE ALSO

Net::UPnP::AV::Content

Net::UPnP::AV::Item

Net::UPnP::AV::Container

AUTHOR

Satoshi Konno skonno@cybergarage.org

CyberGarage http://www.cybergarage.org

COPYRIGHT AND LICENSE

Copyright (C) 2005 by Satoshi Konno

It may be used, redistributed, and/or modified under the terms of BSD License.