summaryrefslogtreecommitdiffstats
path: root/lib/class/media.interface.php
blob: 97e018d135aad8030e213789f0938424f033937f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<?php
/* vim:set tabstop=8 softtabstop=8 shiftwidth=8 noexpandtab: */
/**
 *
 * LICENSE: GNU General Public License, version 2 (GPLv2)
 * Copyright 2001 - 2013 Ampache.org
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License v2
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

/**
 * media Interface
 *
 * This defines how the media file classes should
 * work, this lists all required functions and the expected
 * input
 */
interface media {

	/**
	 * format
	 * 
	 * Creates the gussied-up member variables for output 
	 */
	public function format();

	/**
	 * get_stream_types
	 *
	 * Returns an array of strings; current types are 'native'
	 * and 'transcode'
	 */
	public function get_stream_types();

	/**
	 * play_url
	 *
	 * Returns the url to stream the specified object
	 * 
	 */
	public static function play_url($oid);

	/**
	 * get_transcode_settings
	 *
	 * Should only be called if 'transcode' was returned by get_stream_types
	 * Returns a raw transcode command for this item; the optional target
	 * parameter can be used to request a specific format instead of the
	 * default from the configuration file.
	 */
	public function get_transcode_settings($target = null);

	/**
	 * has_flag
	 *
	 */
	public function has_flag();

} // end interface
?>