/ 
StreamFinder-1.47
River stage one • 1 direct dependent • 2 total dependents
/ StreamFinder::Castbox

NAME

StreamFinder::Castbox - Fetch actual raw streamable podcast URLs on castbox.com

AUTHOR

This module is Copyright (C) 2021 by

Jim Turner, <turnerjw784 at yahoo.com>

Email: turnerjw784@yahoo.com

All rights reserved.

You may distribute this module under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl README file.

SYNOPSIS

#!/usr/bin/perl

use strict;

use StreamFinder::Castbox;

die "..usage:  $0 URL\n"  unless ($ARGV[0]);

my $podcast = new StreamFinder::Castbox($ARGV[0]);

die "Invalid URL or no streams found!\n"  unless ($podcast);

my $firstStream = $podcast->get();

print "First Stream URL=$firstStream\n";

my $url = $podcast->getURL();

print "Stream URL=$url\n";

my $podcastTitle = $podcast->getTitle();

print "Title=$podcastTitle\n";

my $podcastDescription = $podcast->getTitle('desc');

print "Description=$podcastDescription\n";

my $podcastID = $podcast->getID();

print "Podcast ID=$podcastID\n";

my $icon_url = $podcast->getIconURL();

if ($icon_url) {   #SAVE THE ICON TO A TEMP. FILE:

	print "Icon URL=$icon_url=\n";

	my ($image_ext, $icon_image) = $podcast->getIconData();

	if ($icon_image && open IMGOUT, ">/tmp/${podcastID}.$image_ext") {

		binmode IMGOUT;

		print IMGOUT $icon_image;

		close IMGOUT;

		print "...Icon image downloaded to (/tmp/${podcastID}.$image_ext)\n";

	}

}

my $stream_count = $podcast->count();

print "--Stream count=$stream_count=\n";

my @streams = $podcast->get();

foreach my $s (@streams) {

	print "------ stream URL=$s=\n";

}

DESCRIPTION

StreamFinder::Castbox accepts a valid podcast ID or URL on Castbox.com and returns the actual stream URL(s), title, and cover art icon. The purpose is that one needs one of these URLs in order to have the option to stream the podcast in one's own choice of media player software rather than using their web browser and accepting any / all flash, ads, javascript, cookies, trackers, web-bugs, and other crapware that can come with that method of play. The author uses his own custom all-purpose media player called "fauxdacious" (his custom hacked version of the open-source "audacious" audio player). "fauxdacious" can incorporate this module to decode and play Castbox.com streams.

One or more stream URLs can be returned for each podcast.

SUBROUTINES/METHODS

new(url [, -secure [ => 0|1 ]] [, -debug [ => 0|1|2 ] ... ])

Accepts a www.castbox.com podcast URL and creates and returns a a new podcast object, or undef if the URL is not a valid podcast, or no streams are found. The URL MUST be the full URL, ie. https://castbox.fm/episode/title-idchannel-id-idepisode-id, or https://castbox.fm/channel/idchannel-id as I know of no way to look up a podcast on Castbox with just an episode ID. If no episode-id is specified, the first (latest) episode for the channel is returned.

The optional -secure argument can be either 0 or 1 (false or true). If 1 then only secure ("https://") streams will be returned.

DEFAULT -secure is 0 (false) - return all streams (http and https).

$podcast->get(['playlist'])

Returns an array of strings representing all stream URLs found. If "playlist" is specified, then an extended m3u playlist is returned instead of stream url(s). NOTE: If an author / channel page url is given, rather than an individual podcast episode's url, get() returns the first (latest?) podcast episode found, and get("playlist") returns an extended m3u playlist containing the urls, titles, etc. for all the podcast episodes found on that page url.

$podcast->getURL([options])

Similar to get() except it only returns a single stream representing the first valid stream found. There currently are no valid options.

$podcast->count()

Returns the number of streams found for the podcast.

$podcast->getID()

Returns the podcast's Castbox ID (default). For podcasts, the Castbox ID is a single value. For individual podcast episodes it's two values separated by a slash ("/").

$podcast->getTitle(['desc'])

Returns the podcast's title, or (long description). Podcasts on Castbox can have separate descriptions, but for podcasts, it is always the podcast's title.

$podcast->getIconURL()

Returns the URL for the podcast's "cover art" icon image, if any.

$podcast->getIconData()

Returns a two-element array consisting of the extension (ie. "png", "gif", "jpeg", etc.) and the actual icon image (binary data), if any.

$podcast->getImageURL()

Returns the URL for the podcast's "cover art" (usually larger) banner image.

$podcast->getImageData()

Returns a two-element array consisting of the extension (ie. "png", "gif", "jpeg", etc.) and the actual podcast's banner image (binary data).

$podcast->getType()

Returns the podcast's type ("Castbox").

CONFIGURATION FILES

~/.config/StreamFinder/Castbox/config

Optional text file for specifying various configuration options for a specific site (submodule). Each option is specified on a separate line in the format below:

'option' => 'value' [,]

and the options are loaded into a hash used only by the specific (submodule) specified. Valid options include -debug => [0|1|2], and most of the LWP::UserAgent options. Blank lines and lines starting with a "#" sign are ignored.

Options specified here override any specified in ~/.config/StreamFinder/config.

~/.config/StreamFinder/config

Optional text file for specifying various configuration options. Each option is specified on a separate line in the format below:

'option' => 'value' [,]

and the options are loaded into a hash used by all sites (submodules) that support them. Valid options include -debug => [0|1|2], and most of the LWP::UserAgent options.

NOTE: Options specified in the options parameter list will override those corresponding options specified in these files.

KEYWORDS

castbox

DEPENDENCIES

URI::Escape, HTML::Entities, LWP::UserAgent

RECCOMENDS

wget

BUGS

Please report any bugs or feature requests to bug-streamFinder-iheartradio at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=StreamFinder-Castbox. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc StreamFinder::Castbox

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2021 Jim Turner.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.